Docs Packages
  1. Packages
  2. Akamai
  3. API Docs
  4. getPropertyRulesBuilder
Akamai v7.1.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-akamai

akamai.getPropertyRulesBuilder

Explore with Pulumi AI

akamai logo
Akamai v7.1.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-akamai

    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,
                               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,
                               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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: akamai:index/getPropertyRulesBuilder:getPropertyRulesBuilder
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getPropertyRulesBuilder Result

    The following output properties are available:

    Supporting Types

    GetPropertyRulesBuilderRulesV20230105

    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors List<GetPropertyRulesBuilderRulesV20230105Behavior>
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions List<GetPropertyRulesBuilderRulesV20230105Criterion>
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20230105CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables List<GetPropertyRulesBuilderRulesV20230105Variable>
    A list of variables for a rule
    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors []GetPropertyRulesBuilderRulesV20230105Behavior
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions []GetPropertyRulesBuilderRulesV20230105Criterion
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20230105CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables []GetPropertyRulesBuilderRulesV20230105Variable
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride String
    XML metadata of the rule
    behaviors List<GetPropertyRulesBuilderRulesV20230105Behavior>
    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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<GetPropertyRulesBuilderRulesV20230105Criterion>
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20230105CustomOverride
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid String
    The UUID of a rule template
    uuid String
    The UUID of the rule
    variables List<GetPropertyRulesBuilderRulesV20230105Variable>
    A list of variables for a rule
    name string
    The name of a rule
    advancedOverride string
    XML metadata of the rule
    behaviors GetPropertyRulesBuilderRulesV20230105Behavior[]
    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
    criteriaLocked boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    criterions GetPropertyRulesBuilderRulesV20230105Criterion[]
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20230105CustomOverride
    XML metadata of the rule
    isSecure boolean
    States whether a rule is secure
    templateLink string
    The template link for the rule
    templateUuid string
    The UUID of a rule template
    uuid string
    The UUID of the rule
    variables GetPropertyRulesBuilderRulesV20230105Variable[]
    A list of variables for a rule
    name str
    The name of a rule
    advanced_override str
    XML metadata of the rule
    behaviors Sequence[GetPropertyRulesBuilderRulesV20230105Behavior]
    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_satisfy str
    States whether 'all' criteria need to match or 'any'
    criterions Sequence[GetPropertyRulesBuilderRulesV20230105Criterion]
    The list of criteria for a rule
    custom_override GetPropertyRulesBuilderRulesV20230105CustomOverride
    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[GetPropertyRulesBuilderRulesV20230105Variable]
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride 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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<Property Map>
    The list of criteria for a rule
    customOverride Property Map
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid 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

    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230105BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20230105BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20230105BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230105BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20230105BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20230105BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20230105BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20230105BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20230105BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20230105BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20230105BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20230105BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20230105BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20230105BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20230105BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20230105BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20230105BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20230105BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20230105BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20230105BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20230105BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20230105BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20230105BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20230105BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230105BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20230105BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20230105BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapperAdvanced
    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.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20230105BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20230105BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20230105BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20230105BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20230105BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20230105BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20230105BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20230105BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230105BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20230105BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20230105BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20230105BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20230105BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20230105BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20230105BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20230105BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20230105BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20230105BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20230105BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20230105BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20230105BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20230105BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20230105BehaviorEdgeWorker
    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.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230105BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20230105BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20230105BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    FrontEndOptimization GetPropertyRulesBuilderRulesV20230105BehaviorFrontEndOptimization
    This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20230105BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20230105BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20230105BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20230105BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20230105BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20230105BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230105BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230105BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20230105BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20230105BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20230105BehaviorInclude
    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.
    InputValidation GetPropertyRulesBuilderRulesV20230105BehaviorInputValidation
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Instant GetPropertyRulesBuilderRulesV20230105BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20230105BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20230105BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20230105BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20230105BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20230105BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230105BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20230105BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230105BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20230105BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20230105BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20230105BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230105BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20230105BehaviorOriginIpAcl
    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.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230105BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20230105BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20230105BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20230105BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20230105BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20230105BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230105BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20230105BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20230105BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20230105BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20230105BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20230105BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20230105BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20230105BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20230105BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20230105BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20230105BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20230105BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20230105BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20230105BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20230105BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20230105BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20230105BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20230105BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20230105BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20230105BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20230105BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20230105BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20230105BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20230105BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20230105BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20230105BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    Shutr GetPropertyRulesBuilderRulesV20230105BehaviorShutr
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20230105BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20230105BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20230105BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20230105BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20230105BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20230105BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20230105BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20230105BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20230105BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20230105BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20230105BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20230105BehaviorWebdav
    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.
    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230105BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20230105BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20230105BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230105BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20230105BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20230105BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20230105BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20230105BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20230105BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20230105BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20230105BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20230105BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20230105BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20230105BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20230105BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20230105BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20230105BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20230105BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20230105BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20230105BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20230105BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20230105BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20230105BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20230105BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230105BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20230105BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20230105BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapperAdvanced
    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.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20230105BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20230105BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20230105BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20230105BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20230105BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20230105BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20230105BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20230105BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230105BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20230105BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20230105BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20230105BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20230105BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20230105BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20230105BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20230105BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20230105BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20230105BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20230105BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20230105BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20230105BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20230105BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20230105BehaviorEdgeWorker
    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.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230105BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20230105BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20230105BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    FrontEndOptimization GetPropertyRulesBuilderRulesV20230105BehaviorFrontEndOptimization
    This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20230105BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20230105BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20230105BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20230105BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20230105BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20230105BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230105BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230105BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20230105BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20230105BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20230105BehaviorInclude
    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.
    InputValidation GetPropertyRulesBuilderRulesV20230105BehaviorInputValidation
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Instant GetPropertyRulesBuilderRulesV20230105BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20230105BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20230105BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20230105BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20230105BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20230105BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230105BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20230105BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230105BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20230105BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20230105BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20230105BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230105BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20230105BehaviorOriginIpAcl
    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.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230105BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20230105BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20230105BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20230105BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20230105BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20230105BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230105BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20230105BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20230105BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20230105BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20230105BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20230105BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20230105BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20230105BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20230105BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20230105BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20230105BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20230105BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20230105BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20230105BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20230105BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20230105BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20230105BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20230105BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20230105BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20230105BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20230105BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20230105BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20230105BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20230105BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20230105BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20230105BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    Shutr GetPropertyRulesBuilderRulesV20230105BehaviorShutr
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20230105BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20230105BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20230105BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20230105BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20230105BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20230105BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20230105BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20230105BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20230105BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20230105BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20230105BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20230105BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230105BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230105BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20230105BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230105BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20230105BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20230105BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20230105BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20230105BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20230105BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20230105BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20230105BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20230105BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20230105BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20230105BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20230105BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230105BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20230105BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230105BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20230105BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20230105BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20230105BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20230105BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20230105BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20230105BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230105BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20230105BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20230105BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapperAdvanced
    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.
    conditionalOrigin GetPropertyRulesBuilderRulesV20230105BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20230105BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20230105BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20230105BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20230105BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20230105BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230105BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230105BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230105BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20230105BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20230105BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20230105BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20230105BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20230105BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20230105BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20230105BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20230105BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20230105BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20230105BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20230105BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20230105BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20230105BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20230105BehaviorEdgeWorker
    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.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230105BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20230105BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20230105BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    frontEndOptimization GetPropertyRulesBuilderRulesV20230105BehaviorFrontEndOptimization
    This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230105BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20230105BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20230105BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20230105BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20230105BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20230105BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230105BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230105BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20230105BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20230105BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230105BehaviorInclude
    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.
    inputValidation GetPropertyRulesBuilderRulesV20230105BehaviorInputValidation
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    instant GetPropertyRulesBuilderRulesV20230105BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20230105BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20230105BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20230105BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20230105BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20230105BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230105BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20230105BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230105BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20230105BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20230105BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20230105BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230105BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20230105BehaviorOriginIpAcl
    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.
    persistentClientConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230105BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20230105BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230105BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20230105BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20230105BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20230105BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230105BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20230105BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20230105BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230105BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20230105BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20230105BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20230105BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230105BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230105BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20230105BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20230105BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20230105BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230105BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20230105BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20230105BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20230105BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20230105BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20230105BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20230105BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20230105BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20230105BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20230105BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20230105BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20230105BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20230105BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20230105BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    shutr GetPropertyRulesBuilderRulesV20230105BehaviorShutr
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20230105BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20230105BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20230105BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20230105BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20230105BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20230105BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20230105BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230105BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20230105BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230105BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20230105BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230105BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230105BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230105BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20230105BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230105BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20230105BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20230105BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20230105BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20230105BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20230105BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20230105BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20230105BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20230105BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20230105BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20230105BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20230105BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230105BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20230105BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230105BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20230105BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20230105BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20230105BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20230105BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20230105BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20230105BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230105BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20230105BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20230105BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapperAdvanced
    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.
    conditionalOrigin GetPropertyRulesBuilderRulesV20230105BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20230105BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20230105BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20230105BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20230105BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20230105BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230105BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230105BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230105BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20230105BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20230105BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20230105BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230105BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20230105BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20230105BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20230105BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20230105BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20230105BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20230105BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20230105BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20230105BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20230105BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20230105BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20230105BehaviorEdgeWorker
    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.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230105BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20230105BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20230105BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    frontEndOptimization GetPropertyRulesBuilderRulesV20230105BehaviorFrontEndOptimization
    This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230105BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20230105BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20230105BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20230105BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20230105BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20230105BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230105BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230105BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20230105BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20230105BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230105BehaviorInclude
    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.
    inputValidation GetPropertyRulesBuilderRulesV20230105BehaviorInputValidation
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    instant GetPropertyRulesBuilderRulesV20230105BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20230105BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20230105BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20230105BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20230105BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20230105BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20230105BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230105BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20230105BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230105BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20230105BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20230105BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20230105BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20230105BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230105BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20230105BehaviorOriginIpAcl
    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.
    persistentClientConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230105BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20230105BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230105BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20230105BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20230105BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20230105BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230105BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20230105BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20230105BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230105BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20230105BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20230105BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20230105BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230105BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230105BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20230105BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20230105BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20230105BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230105BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20230105BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20230105BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20230105BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20230105BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20230105BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20230105BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20230105BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20230105BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20230105BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20230105BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20230105BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20230105BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20230105BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    shutr GetPropertyRulesBuilderRulesV20230105BehaviorShutr
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20230105BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20230105BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20230105BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20230105BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20230105BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20230105BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20230105BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230105BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20230105BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20230105BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230105BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20230105BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230105BehaviorWebdav
    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_circuit_breaker GetPropertyRulesBuilderRulesV20230105BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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 GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptive_image_compression GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230105BehaviorAdvanced
    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 GetPropertyRulesBuilderRulesV20230105BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizer_tag GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizerTag
    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_in_cache_hierarchy GetPropertyRulesBuilderRulesV20230105BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allow_cloudlets_origins GetPropertyRulesBuilderRulesV20230105BehaviorAllowCloudletsOrigins
    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 GetPropertyRulesBuilderRulesV20230105BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_https_cache_key_sharing GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allow_https_downgrade GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsDowngrade
    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 GetPropertyRulesBuilderRulesV20230105BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allow_patch GetPropertyRulesBuilderRulesV20230105BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_post GetPropertyRulesBuilderRulesV20230105BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_put GetPropertyRulesBuilderRulesV20230105BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allow_transfer_encoding GetPropertyRulesBuilderRulesV20230105BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    alt_svc_header GetPropertyRulesBuilderRulesV20230105BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    api_prioritization GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    application_load_balancer GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer
    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 GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation
    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_validation GetPropertyRulesBuilderRulesV20230105BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    base_directory GetPropertyRulesBuilderRulesV20230105BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    boss_beaconing GetPropertyRulesBuilderRulesV20230105BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230105BehaviorBreadcrumbs
    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 GetPropertyRulesBuilderRulesV20230105BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230105BehaviorBrotli
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cache_id GetPropertyRulesBuilderRulesV20230105BehaviorCacheId
    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_ignore_case GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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_query_params GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyQueryParams
    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_rewrite GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyRewrite
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCachePost
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCacheRedirect
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCacheTag
    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. The cacheTag 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_visible GetPropertyRulesBuilderRulesV20230105BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230105BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    central_authorization GetPropertyRulesBuilderRulesV20230105BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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 GetPropertyRulesBuilderRulesV20230105BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    client_characteristics GetPropertyRulesBuilderRulesV20230105BehaviorClientCharacteristics
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCloudInterconnects
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloud_wrapper_advanced GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapperAdvanced
    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 GetPropertyRulesBuilderRulesV20230105BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    construct_response GetPropertyRulesBuilderRulesV20230105BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    content_characteristics GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristics
    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_amd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsAmd
    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_dd GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsDd
    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_wsd_large_file GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLargeFile
    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_wsd_live GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLive
    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_wsd_vod GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdVod
    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_position GetPropertyRulesBuilderRulesV20230105BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    content_targeting_protection GetPropertyRulesBuilderRulesV20230105BehaviorContentTargetingProtection
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCorsSupport
    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 GetPropertyRulesBuilderRulesV20230105BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    custom_behavior GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230105BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230105BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcp_auth_hmac_transformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_regex_transformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_substring_transformation GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_variable_extractor GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthVariableExtractor
    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_authz_groups GetPropertyRulesBuilderRulesV20230105BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcp_dev_relations GetPropertyRulesBuilderRulesV20230105BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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_time_auth GetPropertyRulesBuilderRulesV20230105BehaviorDcpRealTimeAuth
    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 GetPropertyRulesBuilderRulesV20230105BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    deny_access GetPropertyRulesBuilderRulesV20230105BehaviorDenyAccess
    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_failover_access GetPropertyRulesBuilderRulesV20230105BehaviorDenyDirectFailoverAccess
    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_cache_id GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicCacheId
    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_header GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dns_async_refresh GetPropertyRulesBuilderRulesV20230105BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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 GetPropertyRulesBuilderRulesV20230105BehaviorDnsPrefresh
    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 GetPropertyRulesBuilderRulesV20230105BehaviorDowngradeProtocol
    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_marker GetPropertyRulesBuilderRulesV20230105BehaviorDownloadCompleteMarker
    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 GetPropertyRulesBuilderRulesV20230105BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstream_cache GetPropertyRulesBuilderRulesV20230105BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamic_throughtput_optimization GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimization
    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_optimization_override GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimizationOverride
    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_content GetPropertyRulesBuilderRulesV20230105BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecms_bulk_upload GetPropertyRulesBuilderRulesV20230105BehaviorEcmsBulkUpload
    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 GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecms_dataset GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDataset
    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_key GetPropertyRulesBuilderRulesV20230105BehaviorEcmsObjectKey
    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 GetPropertyRulesBuilderRulesV20230105BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edge_load_balancing_advanced GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingAdvanced
    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_balancing_data_center GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenter
    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_balancing_origin GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin
    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.
    edge_origin_authorization GetPropertyRulesBuilderRulesV20230105BehaviorEdgeOriginAuthorization
    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 GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edge_scape GetPropertyRulesBuilderRulesV20230105BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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_includes GetPropertyRulesBuilderRulesV20230105BehaviorEdgeSideIncludes
    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, or filename. 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 GetPropertyRulesBuilderRulesV20230105BehaviorEdgeWorker
    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_protocol GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedAkamaiProtocol
    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_detection GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedProxyDetection
    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_header_enrichment GetPropertyRulesBuilderRulesV20230105BehaviorEpdForwardHeaderEnrichment
    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 GetPropertyRulesBuilderRulesV20230105BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failover_bot_manager_feature_compatibility GetPropertyRulesBuilderRulesV20230105BehaviorFailoverBotManagerFeatureCompatibility
    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 GetPropertyRulesBuilderRulesV20230105BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    first_party_marketing GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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_marketing_plus GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing 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 GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    front_end_optimization GetPropertyRulesBuilderRulesV20230105BehaviorFrontEndOptimization
    This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230105BehaviorG2oheader
    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_number GetPropertyRulesBuilderRulesV20230105BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphql_caching GetPropertyRulesBuilderRulesV20230105BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzip_response GetPropertyRulesBuilderRulesV20230105BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hd_data_advanced GetPropertyRulesBuilderRulesV20230105BehaviorHdDataAdvanced
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHealthDetection
    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_binding GetPropertyRulesBuilderRulesV20230105BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230105BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    http_strict_transport_security GetPropertyRulesBuilderRulesV20230105BehaviorHttpStrictTransportSecurity
    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_https_upgrade GetPropertyRulesBuilderRulesV20230105BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    im_override GetPropertyRulesBuilderRulesV20230105BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    image_and_video_manager GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManager
    This behavior can be used in includes.
    image_manager GetPropertyRulesBuilderRulesV20230105BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    image_manager_video GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230105BehaviorInclude
    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 GetPropertyRulesBuilderRulesV20230105BehaviorInputValidation
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    instant GetPropertyRulesBuilderRulesV20230105BehaviorInstant
    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 GetPropertyRulesBuilderRulesV20230105BehaviorInstantConfig
    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_optimization GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    large_file_optimization_advanced GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limit_bit_rate GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    log_custom GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    m_pulse GetPropertyRulesBuilderRulesV20230105BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifest_personalization GetPropertyRulesBuilderRulesV20230105BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifest_rerouting GetPropertyRulesBuilderRulesV20230105BehaviorManifestRerouting
    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_push GetPropertyRulesBuilderRulesV20230105BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    media_acceleration GetPropertyRulesBuilderRulesV20230105BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    media_acceleration_quic_optout GetPropertyRulesBuilderRulesV20230105BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    media_client GetPropertyRulesBuilderRulesV20230105BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    media_file_retrieval_optimization GetPropertyRulesBuilderRulesV20230105BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    media_origin_failover GetPropertyRulesBuilderRulesV20230105BehaviorMediaOriginFailover
    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 GetPropertyRulesBuilderRulesV20230105BehaviorMetadataCaching
    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_performance GetPropertyRulesBuilderRulesV20230105BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modify_incoming_request_header GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modify_incoming_response_header GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modify_outgoing_request_header GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modify_outgoing_response_header GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modify_via_header GetPropertyRulesBuilderRulesV20230105BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230105BehaviorOrigin
    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 GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics
    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_wsd GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    origin_failure_recovery_method GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    origin_failure_recovery_policy GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    origin_ip_acl GetPropertyRulesBuilderRulesV20230105BehaviorOriginIpAcl
    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_connection GetPropertyRulesBuilderRulesV20230105BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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 GetPropertyRulesBuilderRulesV20230105BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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_information GetPropertyRulesBuilderRulesV20230105BehaviorPersonallyIdentifiableInformation
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230105BehaviorPreconnect
    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_delivery GetPropertyRulesBuilderRulesV20230105BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictive_prefetching GetPropertyRulesBuilderRulesV20230105BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230105BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefresh_cache GetPropertyRulesBuilderRulesV20230105BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230105BehaviorQuality
    This behavior can be used in includes.
    quic_beta GetPropertyRulesBuilderRulesV20230105BehaviorQuicBeta
    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 GetPropertyRulesBuilderRulesV20230105BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230105BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    read_timeout GetPropertyRulesBuilderRulesV20230105BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    real_time_reporting GetPropertyRulesBuilderRulesV20230105BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    real_user_monitoring GetPropertyRulesBuilderRulesV20230105BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230105BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230105BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    referer_checking GetPropertyRulesBuilderRulesV20230105BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    remove_query_parameter GetPropertyRulesBuilderRulesV20230105BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    remove_vary GetPropertyRulesBuilderRulesV20230105BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230105BehaviorReport
    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 GetPropertyRulesBuilderRulesV20230105BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    request_type_marker GetPropertyRulesBuilderRulesV20230105BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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 GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resource_optimizer_extended_compatibility GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizerExtendedCompatibility
    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 GetPropertyRulesBuilderRulesV20230105BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    response_cookie GetPropertyRulesBuilderRulesV20230105BehaviorResponseCookie
    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_caching GetPropertyRulesBuilderRulesV20230105BehaviorRestrictObjectCaching
    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_status GetPropertyRulesBuilderRulesV20230105BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewrite_url GetPropertyRulesBuilderRulesV20230105BehaviorRewriteUrl
    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 GetPropertyRulesBuilderRulesV20230105BehaviorRumCustom
    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 GetPropertyRulesBuilderRulesV20230105BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    sales_force_commerce_cloud_client GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudClient
    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_commerce_cloud_provider GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    sales_force_commerce_cloud_provider_host_header GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    save_post_dca_processing GetPropertyRulesBuilderRulesV20230105BehaviorSavePostDcaProcessing
    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 GetPropertyRulesBuilderRulesV20230105BehaviorScheduleInvalidation
    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 GetPropertyRulesBuilderRulesV20230105BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmented_content_protection GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmented_media_optimization GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmented_media_streaming_prefetch GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaStreamingPrefetch
    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 GetPropertyRulesBuilderRulesV20230105BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    shutr GetPropertyRulesBuilderRulesV20230105BehaviorShutr
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    simulate_error_code GetPropertyRulesBuilderRulesV20230105BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    site_shield GetPropertyRulesBuilderRulesV20230105BehaviorSiteShield
    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_migration GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standard_tls_migration_override GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigrationOverride
    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_parsing GetPropertyRulesBuilderRulesV20230105BehaviorStrictHeaderParsing
    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 GetPropertyRulesBuilderRulesV20230105BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sure_route GetPropertyRulesBuilderRulesV20230105BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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 GetPropertyRulesBuilderRulesV20230105BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    tea_leaf GetPropertyRulesBuilderRulesV20230105BehaviorTeaLeaf
    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 GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistribution
    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 the cache 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_advanced GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tiered_distribution_customization GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230105BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uid_configuration GetPropertyRulesBuilderRulesV20230105BehaviorUidConfiguration
    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_tag GetPropertyRulesBuilderRulesV20230105BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verify_json_web_token GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verify_json_web_token_for_dcp GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verify_token_authorization GetPropertyRulesBuilderRulesV20230105BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtual_waiting_room GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtual_waiting_room_with_edge_workers GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoomWithEdgeWorkers
    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 GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo_standalone GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230105BehaviorWatermarking
    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_firewall GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewall
    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 GetPropertyRulesBuilderRulesV20230105BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230105BehaviorWebdav
    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.
    adScalerCircuitBreaker Property Map
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration 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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression Property Map
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. 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.
    aggregatedReporting Property Map
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. 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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag 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.
    allHttpInCacheHierarchy Property Map
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins Property Map
    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.
    allowDelete 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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing Property Map
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade Property Map
    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.
    allowOptions 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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch 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, and allowPut behaviors. This behavior can be used in includes.
    allowPost 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, and allowPut behaviors. This behavior can be used in includes.
    allowPut 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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding Property Map
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader Property Map
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization 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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer Property Map
    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.
    audienceSegmentation 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.
    autoDomainValidation Property Map
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory Property Map
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing 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.
    breadcrumbs 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.
    breakConnection 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.
    cacheError 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, and 505. This behavior can be used in includes.
    cacheId 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.
    cacheKeyIgnoreCase Property Map
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams Property Map
    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.
    cacheKeyRewrite Property Map
    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.
    cachePost 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.
    cacheRedirect 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.
    cacheTag 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. The cacheTag 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.
    cacheTagVisible Property Map
    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 the modifyOutgoingResponseHeader 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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization 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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects Property Map
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCharacteristics 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.
    cloudInterconnects 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.
    cloudWrapper 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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced Property Map
    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.
    conditionalOrigin Property Map
    This behavior cannot be used in includes.
    constructResponse 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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics 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.
    contentCharacteristicsAmd 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.
    contentCharacteristicsDd 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.
    contentCharacteristicsWsdLargeFile Property Map
    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.
    contentCharacteristicsWsdLive Property Map
    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.
    contentCharacteristicsWsdVod Property Map
    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.
    contentPrePosition Property Map
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection Property Map
    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.
    corsSupport 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.
    cpCode 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 the List CP codes operation. This behavior can be used in includes.
    customBehavior 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 relevant behaviorId value from the response within the current customBehavior. See Custom 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 the DataStream 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. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor Property Map
    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.
    dcpDefaultAuthzGroups Property Map
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations Property Map
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth Property Map
    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.
    deliveryReceipt 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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess 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.
    denyDirectFailoverAccess Property Map
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId Property Map
    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.
    deviceCharacteristicHeader Property Map
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh Property Map
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh 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.
    downgradeProtocol 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.
    downloadCompleteMarker 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 logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes.
    downloadNotification 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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache 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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization Property Map
    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.
    dynamicThroughtputOptimizationOverride Property Map
    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.
    dynamicWebContent Property Map
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload Property Map
    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.
    ecmsDatabase 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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset 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.
    ecmsObjectKey Property Map
    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.
    edgeConnect Property Map
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced Property Map
    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.
    edgeLoadBalancingDataCenter Property Map
    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.
    edgeLoadBalancingOrigin Property Map
    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.
    edgeOriginAuthorization 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.
    edgeRedirector Property Map
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape 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 special X-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.
    edgeSideIncludes Property Map
    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, or filename. 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.
    edgeWorker 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.
    enhancedAkamaiProtocol Property Map
    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.
    enhancedProxyDetection Property Map
    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.
    epdForwardHeaderEnrichment Property Map
    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.
    failAction 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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility Property Map
    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.
    fastInvalidate Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    firstPartyMarketing Property Map
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus Property Map
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    frontEndOptimization Property Map
    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.
    globalRequestNumber Property Map
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching Property Map
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse 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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced Property Map
    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.
    healthDetection 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.
    hsafEipBinding Property Map
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity Property Map
    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.
    httpToHttpsUpgrade Property Map
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride 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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager Property Map
    This behavior can be used in includes.
    imageManager 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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo Property Map
    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 a fileExtension. 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.
    inputValidation 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.
    instantConfig 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.
    largeFileOptimization Property Map
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced Property Map
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate Property Map
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom Property Map
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse Property Map
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization 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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting 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.
    manualServerPush Property Map
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration Property Map
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout Property Map
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization Property Map
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover Property Map
    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.
    metadataCaching 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.
    mobileSdkPerformance Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader Property Map
    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.
    originCharacteristics 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.
    originCharacteristicsWsd Property Map
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod Property Map
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy Property Map
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl Property Map
    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.
    persistentClientConnection Property Map
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection Property Map
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation Property Map
    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.
    phasedRelease 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 within Control 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.
    predictiveContentDelivery Property Map
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching 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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache 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.
    quicBeta 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.
    randomSeek 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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout 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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting Property Map
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring Property Map
    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 on destinationHostname and destinationPath 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 use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking Property Map
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter Property Map
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary Property Map
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary 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.
    requestControl 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker Property Map
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility Property Map
    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.
    responseCode 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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie 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.
    restrictObjectCaching Property Map
    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.
    returnCacheStatus Property Map
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl 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.
    rumCustom 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.
    saasDefinitions Property Map
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient Property Map
    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.
    salesForceCommerceCloudProvider Property Map
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader Property Map
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing Property Map
    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.
    scheduleInvalidation 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.
    scriptManagement Property Map
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection Property Map
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization Property Map
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch Property Map
    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.
    setVariable 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 this valueSource, 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 a transform function to modify the value once. See Support 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.
    simulateErrorCode Property Map
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield 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.
    standardTlsMigration Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride 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.
    strictHeaderParsing Property Map
    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.
    subCustomer 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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute Property Map
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf 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.
    tieredDistribution 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 the cache 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.
    tieredDistributionAdvanced 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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization Property Map
    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 enable cloudWrapper 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.
    uidConfiguration 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.
    validateEntityTag Property Map
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken Property Map
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp Property Map
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization Property Map
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom Property Map
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers Property Map
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization Property Map
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo Property Map
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone Property Map
    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.
    webApplicationFirewall Property Map
    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.
    webSockets 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

    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased string
    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.
    responseCodeBased boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased string
    Defines a custom error response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response_code_based str
    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_based bool
    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, or SPECIFY_YOUR_OWN for a custom code.
    response_delay_based bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    response_delay_threshold str
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    return_error_response_code_based str
    Specifies the error to include in the response to the client.
    specify_your_own_response_code_based str
    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.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid string
    This option is for internal usage only.
    titleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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. See Add 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.
    cookie_name str
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enable_brotli_compression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enable_for_noncacheable bool
    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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring 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_server_push str
    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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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

    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Integer
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Integer
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Integer
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Integer
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Integer
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Integer
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    compressMobile boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid string
    This option is for internal usage only.
    tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    tier1MobileCompressionValue number
    Specifies the compression percentage.
    tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue number
    Specifies the compression percentage.
    tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue number
    Specifies the compression percentage.
    tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue number
    Specifies the compression percentage.
    tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue number
    Specifies the compression percentage.
    tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue number
    Specifies the compression percentage.
    titleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    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_compression_method str
    Specifies tier-1 behavior.
    tier1_mobile_compression_value int
    Specifies the compression percentage.
    tier1_standard_compression_method str
    Specifies tier-1 non-cellular network behavior.
    tier1_standard_compression_value int
    Specifies the compression percentage.
    tier2_mobile_compression_method str
    Specifies tier-2 cellular-network behavior.
    tier2_mobile_compression_value int
    Specifies the compression percentage.
    tier2_standard_compression_method str
    Specifies tier-2 non-cellular network behavior.
    tier2_standard_compression_value int
    Specifies the compression percentage.
    tier3_mobile_compression_method str
    Specifies tier-3 cellular-network behavior.
    tier3_mobile_compression_value int
    Specifies the compression percentage.
    tier3_standard_compression_method str
    Specifies tier-3 non-cellular network behavior.
    tier3_standard_compression_value int
    Specifies the compression percentage.
    title_aic_mobile str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    title_aic_nonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Number
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Number
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Number
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Number
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Number
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Number
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname string
    Specifies the replacement hostname for the tag to use.
    scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    include_tags_attribute 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.
    tags_attribute 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.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory boolean
    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.
    purgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_directory bool
    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_query_parameter str
    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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled boolean
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_content_length bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled 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.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge Integer
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the Alt-Svc header. The default max-age for an Alt-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.
    maxAge Number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationCloudletPolicy
    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.
    NetStorage GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationCloudletPolicy
    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.
    NetStorage GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    alternateResponseCacheTtl Integer
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationCloudletPolicy
    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.
    netStorage GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Integer
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.
    alternateResponseCacheTtl number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationCloudletPolicy
    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.
    netStorage GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid string
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode boolean
    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_cache_ttl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationCloudletPolicy
    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 GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    net_storage_path str
    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_code GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttled_status_code int
    Specifies the HTTP response code for requests that receive the alternate response.
    use_throttled_cp_code bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    use_throttled_status_code bool
    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.
    alternateResponseCacheTtl Number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy 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.
    netStorage Property Map
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode Property Map
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer

    AllDownNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps List<GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes List<string>
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllDownNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps []GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes []string
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Integer
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode string
    Determines what to do if an origin fails.
    failoverOriginMaps GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap[]
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes string[]
    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.
    failoverTitle 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.
    originCookieName string
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration string
    Sets how long it is before the cookie expires.
    stickinessExpirationDate string
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_net_storage GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    all_down_net_storage_file str
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    all_down_status_code str
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    all_down_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_cache_prefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cached_content_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Activates the Application Load Balancer Cloudlet.
    failover_attempts_threshold int
    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_maps Sequence[GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap]
    Specifies a fixed set of failover mapping rules.
    failover_status_codes Sequence[str]
    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.
    origin_cookie_name str
    Specifies the name for your session cookie.
    specify_stickiness_cookie_domain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickiness_cookie_automatic_salt 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.
    stickiness_cookie_domain str
    Specifies the domain to track the stickiness cookie.
    stickiness_cookie_salt str
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickiness_cookie_set_http_only_flag bool
    Ensures the cookie is transmitted only over HTTP.
    stickiness_cookie_type 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_date str
    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.
    allDownNetStorage Property Map
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<Property Map>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap

    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds List<string>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds []string
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds string[]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    from_origin_id str
    Specifies the origin whose failure triggers the mapping rule.
    to_origin_ids Sequence[str]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.

    GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation

    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain string
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType string
    Specifies when the segmentation cookie expires.
    populationDuration string
    Specifies the lifetime of the segmentation cookie.
    populationRefresh boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    population_cookie_automatic_salt 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.
    population_cookie_domain str
    Specifies the domain to track the population cookie.
    population_cookie_include_rule_name bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    population_cookie_salt str
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    population_cookie_type 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.
    segment_tracking_cookie_name str
    This cookie name specifies the name of the segmentation rule.
    segment_tracking_custom_header str
    This custom HTTP header specifies the name of the segmentation rule.
    segment_tracking_method str
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segment_tracking_query_param str
    This query parameter specifies the name of the segmentation rule.
    segment_tracking_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specify_population_cookie_domain 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses List<string>
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses []string
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern string
    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.
    conditionalHttpStatuses string[]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency string
    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.
    forwardType 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.
    requestType string
    Specify when to trigger a beacon.
    samplingFrequency string
    Specifies a sampling frequency or disables beacons.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_pattern str
    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_statuses Sequence[str]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditional_sampling_frequency str
    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.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 opposite ak-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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and 504 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 to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey string
    Specifies the new cache key path as an alphanumeric value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    templateUuid string
    This option is for internal usage only.
    useBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    cacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl string
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache boolean
    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 live ttl to zero seconds.
    honorNoStore boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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_directives str
    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_support bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-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_age bool
    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 the max-age directive and the defaultTtl setting.
    honor_must_revalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honor_no_cache bool
    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 live ttl to zero seconds.
    honor_no_store bool
    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_revalidate bool
    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_maxage 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 the max-age directive and the defaultTtl 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CloudLocations 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudLocations []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_map str
    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.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Integer
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode number
    The HTTP response code to send to the end-user client.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Number
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom double
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom double
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom float64
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom float64
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Integer
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Integer
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Double
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Double
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationDashCustom number
    Customizes the number of seconds for the segment.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom number
    Customizes the number of seconds for the fragment.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationHlsCustom number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom number
    Customizes the number of seconds for the fragment.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_dash_custom int
    Customizes the number of seconds for the segment.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hds_custom int
    Customizes the number of seconds for the fragment.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_hls_custom float
    Customizes the number of seconds for the segment.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_duration_smooth_custom float
    Customizes the number of seconds for the fragment.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Number
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Number
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation string
    sourceType string
    targets string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains List<string>
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses []string
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses []string
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains []string
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled boolean
    Enables the Content Targeting feature.
    geoProtectionMode string
    Specifies how to handle requests.
    geoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses string[]
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode string
    Specifies how to handle requests.
    ipProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl string
    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.
    overrideIpAddresses string[]
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains string[]
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode string
    Specify the action to take.
    referrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_protection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enable_geo_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_ip_protection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enable_ip_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_referrer_protection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enable_referrer_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enabled bool
    Enables the Content Targeting feature.
    geo_protection_mode str
    Specifies how to handle requests.
    geo_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geo_redirect_url str
    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_mode str
    Specifies how to handle requests.
    ip_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ip_redirect_url str
    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_addresses Sequence[str]
    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_mode str
    Specify the action to take.
    referrer_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrer_redirect_url str
    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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders []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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflight_max_age str
    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.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior

    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamName int
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamName int
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamName Integer
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Integer
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled boolean
    Enables 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.
    logEnabled boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamName number
    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.
    logStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage number
    Specifies the percentage of log data you want to collect for this property.
    streamType string
    Specify the DataStream type.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collect_midgress_traffic bool
    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_name int
    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_title str
    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.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamName Number
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Number
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.
    namespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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 the IoT 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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

    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm string
    Specifies the hash algorithm.
    hashConversionKey string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_algorithm str
    Specifies the hash algorithm.
    hash_conversion_key str
    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.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField string
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_auth_processing_variable_id str
    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.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GroupNames 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    GroupNames []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname boolean
    Extracts a hostname from JWT.
    extractJurisdiction boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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 a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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

    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_monitoring bool
    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.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern string
    Specifies the regular expression that matches the database name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements List<string>
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements []string
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines string
    Specifies the maximum number of lines to include in each log.
    aggregateSize string
    Specifies the log's maximum size.
    aggregateTime string
    Specifies how often logs are generated.
    apiConnector string
    Describes the API connector type.
    apiDataElements string[]
    Specifies the data set to log.
    destinationHostname string
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings boolean
    When enabled, overrides default log settings.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_elements Sequence[str]
    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_settings bool
    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.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules List<GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules []GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenterFailoverRule
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description string
    Provides a description for the ELB data center, for your own reference.
    enableFailover boolean
    Allows you to specify failover rules.
    failoverRules GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenterFailoverRule[]
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_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[GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenterFailoverRule]
    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 the edgeLoadBalancingOrigin 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.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<Property Map>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname string
    The hostname of the data center to fail over to.
    modifyRequest boolean
    Allows you to modify the request's hostname or path.
    overrideHostname 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.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.

    GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin

    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description string
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description str
    Provides a description for the ELB origin, for your own reference.
    enable_session_persistence bool
    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 the edgeLoadBalancingDataCenter 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_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.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookie_name 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy 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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets List<string>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets []string
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection boolean
    Denies attempts to inject ESI code.
    enableViaHttp boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled boolean
    Enables ESI processing.
    i18nCharsets string[]
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_http bool
    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 and ISO-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_ip bool
    Allows edge servers to pass the client IP header to the ESI processor.
    pass_set_cookie 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.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId string
    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.
    resourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_worker str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edge_worker_id str
    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.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction string
    Specifies how to field the proxy request.
    bestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction string
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy boolean
    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.
    detectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode string
    Specifies how to field the proxy request.
    enabled boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment boolean
    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.
    hostingProvider 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.
    publicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter string
    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_action str
    Specifies how to field the proxy request.
    best_practice_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_anonymous_vpn bool
    This enables detection of requests from anonymous VPNs.
    detect_anonymous_vpn_action str
    Specifies how to field anonymous VPN requests.
    detect_anonymous_vpn_redirecturl str
    This specifies the URL to which to redirect anonymous VPN requests.
    detect_hosting_provider bool
    This detects requests from a hosting provider.
    detect_hosting_provider_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detect_hosting_provider_redirecturl str
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detect_public_proxy bool
    This enables detection of requests from public proxies.
    detect_public_proxy_action str
    Specifies how to field public proxy requests.
    detect_public_proxy_redirecturl str
    This specifies the URL to which to redirect public proxy requests.
    detect_residential_proxy bool
    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_proxy_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detect_residential_proxy_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_smart_dns_proxy bool
    This enables detection of requests from smart DNS proxies.
    detect_smart_dns_proxy_action str
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detect_smart_dns_proxy_redirecturl str
    This specifies the URL to which to redirect DNS proxy requests.
    detect_tor_exit_node bool
    This enables detection of requests from Tor exit nodes.
    detect_tor_exit_node_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detect_tor_exit_node_redirecturl str
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detect_vpn_data_center bool
    This enables detection of requests from VPN data centers.
    detect_vpn_data_center_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detect_vpn_data_center_redirecturl str
    This specifies the URL to which to redirect requests from VPN data centers.
    enable_configuration_mode str
    Specifies how to field the proxy request.
    enabled bool
    Applies GeoGuard proxy detection.
    forward_header_enrichment bool
    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_proxy 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.
    tor_exit_node 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.
    vpn_data_center str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Integer
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Integer
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Integer
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride boolean
    cexCustomPath boolean
    Specifies a custom path.
    cexHostname string
    Specifies a hostname.
    cexPath string
    Specifies a custom path.
    contentCustomPath boolean
    Specifies a custom redirect path.
    contentHostname string
    Specifies the static hostname for the alternate redirect.
    contentPath string
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath boolean
    Allows you to modify the original requested path.
    dynamicMethod string
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath boolean
    Uses the redirectPath to customize a new path.
    redirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType string
    Whether to preserve or customize the hostname.
    redirectMethod number
    Specifies the HTTP response code.
    redirectPath string
    Specifies a new path.
    saasCnameEnabled boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    saasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode number
    Assigns a new HTTP status code to the failure response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_parent_override bool
    cex_custom_path bool
    Specifies a custom path.
    cex_hostname str
    Specifies a hostname.
    cex_path str
    Specifies a custom path.
    content_custom_path bool
    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 GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamic_custom_path bool
    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_hostname GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    net_storage_path str
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserve_query_string bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol str
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirect_custom_path bool
    Uses the redirectPath to customize a new path.
    redirect_hostname str
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirect_hostname_type str
    Whether to preserve or customize the hostname.
    redirect_method int
    Specifies the HTTP response code.
    redirect_path str
    Specifies a new path.
    saas_cname_enabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saas_cname_level int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saas_query_string str
    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.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode Property Map
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname Property Map
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Number
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Number
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname

    cpCode Integer
    downloadDomainName String
    g2oToken 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus

    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite

    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CustomSignStrings List<string>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    CustomSignStrings []string
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Integer
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customSignStrings string[]
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled boolean
    Enables the g2o verification behavior.
    encodingVersion number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked boolean
    Indicates 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.
    secretKey string
    Specifies the shared secret key.
    signedHeader string
    Specifies the name of the header containing encrypted request data.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_strings Sequence[str]
    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 through 5.
    locked bool
    Indicates 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_sign_string bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption string
    Specifies how to report the GRN value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors boolean
    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.
    operationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_with_errors bool
    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_body_parameter_name str
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operations_url_query_parameter_name str
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    post_request_processing_error_handling str
    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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects 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 of retryCount.
    retryCount Integer
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 of retryCount.
    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.
    maximumReconnects Number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount Number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Integer
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Integer
    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.
    templateUuid 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.
    customExtractedSerial boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue number
    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.
    templateUuid 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_serial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hash_max_value int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hash_min_value int
    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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Number
    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.
    templateUuid 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Integer
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains boolean
    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.
    maxAge 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.
    redirectStatusCode number
    Specifies a response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_domains bool
    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_code int
    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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Number
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters List<string>
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters []string
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.
    excludeAllQueryParameters boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters string[]
    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.
    policyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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_query_parameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excluded_query_parameters Sequence[str]
    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_mvar str
    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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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

    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    applyBestFileType Boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String
    applyBestFileType boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed
    enabled boolean
    imageSet 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.
    policySetType string
    resize boolean
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet string
    apply_best_file_type bool
    cp_code_original GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal
    cp_code_transformed GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed
    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_type str
    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
    applyBestFileType Boolean
    cpCodeOriginal Property Map
    cpCodeTransformed Property Map
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String

    GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType 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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    api_reference_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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_default str
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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_region str
    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_policy_set bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal Property Map
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType 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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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_default str
    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_region str
    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_policy_set bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal Property Map
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    AllowLargePostBody bool
    Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy
    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.
    Penalty403NetStoragePath string
    Specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.
    PenaltyAction string
    Once the penaltyThreshold of invalid requests is met, this specifies the response.
    PenaltyBrandedDenyCacheTtl int
    Specifies the penalty response's time to live in the cache, 5 minutes by default.
    PenaltyNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage
    Specifies the NetStorage account that serves out the penalty's static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.
    PenaltyThreshold int
    Specifies the number of invalid requests permitted before executing the penaltyAction.
    PenaltyTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResetOnValid bool
    Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by specific HTTP headers on GET or POST requests.
    UserIdentificationByIp bool
    When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
    UserIdentificationByParams bool
    When enabled, identifies users by specific query parameters on GET or POST requests.
    UserIdentificationKeyCookie string
    This specifies the cookie name whose value needs to remain constant across requests to identify a user.
    UserIdentificationKeyHeaders List<string>
    This specifies the HTTP headers whose combined set of values identify each end user.
    UserIdentificationKeyParams List<string>
    This specifies the query parameters whose combined set of values identify each end user.
    UserIdentificationTitle 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.
    ValidateOnOriginHeaderName string
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.
    ValidateOnOriginHeaderValue string
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request's header value that corresponds to the validateOnOriginHeaderName.
    ValidateOnOriginResponseCode int
    Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.
    ValidateOnOriginWith string
    For any validation that edge servers can't perform alone, this specifies additional validation steps based on how the origin identifies an invalid request. If a request is invalid, the origin can indicate this to the edge server.
    ValidationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowLargePostBody bool
    Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy
    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.
    Penalty403NetStoragePath string
    Specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.
    PenaltyAction string
    Once the penaltyThreshold of invalid requests is met, this specifies the response.
    PenaltyBrandedDenyCacheTtl int
    Specifies the penalty response's time to live in the cache, 5 minutes by default.
    PenaltyNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage
    Specifies the NetStorage account that serves out the penalty's static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.
    PenaltyThreshold int
    Specifies the number of invalid requests permitted before executing the penaltyAction.
    PenaltyTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResetOnValid bool
    Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by specific HTTP headers on GET or POST requests.
    UserIdentificationByIp bool
    When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
    UserIdentificationByParams bool
    When enabled, identifies users by specific query parameters on GET or POST requests.
    UserIdentificationKeyCookie string
    This specifies the cookie name whose value needs to remain constant across requests to identify a user.
    UserIdentificationKeyHeaders []string
    This specifies the HTTP headers whose combined set of values identify each end user.
    UserIdentificationKeyParams []string
    This specifies the query parameters whose combined set of values identify each end user.
    UserIdentificationTitle 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.
    ValidateOnOriginHeaderName string
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.
    ValidateOnOriginHeaderValue string
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request's header value that corresponds to the validateOnOriginHeaderName.
    ValidateOnOriginResponseCode int
    Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.
    ValidateOnOriginWith string
    For any validation that edge servers can't perform alone, this specifies additional validation steps based on how the origin identifies an invalid request. If a request is invalid, the origin can indicate this to the edge server.
    ValidationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowLargePostBody Boolean
    Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy
    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.
    penalty403NetStoragePath String
    Specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.
    penaltyAction String
    Once the penaltyThreshold of invalid requests is met, this specifies the response.
    penaltyBrandedDenyCacheTtl Integer
    Specifies the penalty response's time to live in the cache, 5 minutes by default.
    penaltyNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage
    Specifies the NetStorage account that serves out the penalty's static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.
    penaltyThreshold Integer
    Specifies the number of invalid requests permitted before executing the penaltyAction.
    penaltyTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resetOnValid Boolean
    Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by specific HTTP headers on GET or POST requests.
    userIdentificationByIp Boolean
    When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
    userIdentificationByParams Boolean
    When enabled, identifies users by specific query parameters on GET or POST requests.
    userIdentificationKeyCookie String
    This specifies the cookie name whose value needs to remain constant across requests to identify a user.
    userIdentificationKeyHeaders List<String>
    This specifies the HTTP headers whose combined set of values identify each end user.
    userIdentificationKeyParams List<String>
    This specifies the query parameters whose combined set of values identify each end user.
    userIdentificationTitle 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.
    validateOnOriginHeaderName String
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.
    validateOnOriginHeaderValue String
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request's header value that corresponds to the validateOnOriginHeaderName.
    validateOnOriginResponseCode Integer
    Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.
    validateOnOriginWith String
    For any validation that edge servers can't perform alone, this specifies additional validation steps based on how the origin identifies an invalid request. If a request is invalid, the origin can indicate this to the edge server.
    validationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowLargePostBody boolean
    Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy
    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.
    penalty403NetStoragePath string
    Specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.
    penaltyAction string
    Once the penaltyThreshold of invalid requests is met, this specifies the response.
    penaltyBrandedDenyCacheTtl number
    Specifies the penalty response's time to live in the cache, 5 minutes by default.
    penaltyNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage
    Specifies the NetStorage account that serves out the penalty's static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.
    penaltyThreshold number
    Specifies the number of invalid requests permitted before executing the penaltyAction.
    penaltyTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resetOnValid boolean
    Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by specific HTTP headers on GET or POST requests.
    userIdentificationByIp boolean
    When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
    userIdentificationByParams boolean
    When enabled, identifies users by specific query parameters on GET or POST requests.
    userIdentificationKeyCookie string
    This specifies the cookie name whose value needs to remain constant across requests to identify a user.
    userIdentificationKeyHeaders string[]
    This specifies the HTTP headers whose combined set of values identify each end user.
    userIdentificationKeyParams string[]
    This specifies the query parameters whose combined set of values identify each end user.
    userIdentificationTitle 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.
    validateOnOriginHeaderName string
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.
    validateOnOriginHeaderValue string
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request's header value that corresponds to the validateOnOriginHeaderName.
    validateOnOriginResponseCode number
    Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.
    validateOnOriginWith string
    For any validation that edge servers can't perform alone, this specifies additional validation steps based on how the origin identifies an invalid request. If a request is invalid, the origin can indicate this to the edge server.
    validationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_large_post_body bool
    Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy
    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_storage_path str
    Specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.
    penalty_action str
    Once the penaltyThreshold of invalid requests is met, this specifies the response.
    penalty_branded_deny_cache_ttl int
    Specifies the penalty response's time to live in the cache, 5 minutes by default.
    penalty_net_storage GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage
    Specifies the NetStorage account that serves out the penalty's static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.
    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_valid bool
    Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.
    template_uuid str
    This option is for internal usage only.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by specific HTTP headers on GET or POST requests.
    user_identification_by_ip bool
    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_by_params bool
    When enabled, identifies users by specific query parameters on GET or POST requests.
    user_identification_key_cookie str
    This specifies the cookie name whose value needs to remain constant across requests to identify a user.
    user_identification_key_headers Sequence[str]
    This specifies the HTTP headers whose combined set of values identify each end user.
    user_identification_key_params Sequence[str]
    This specifies the query parameters whose combined set of values identify each end user.
    user_identification_title 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.
    validate_on_origin_header_name str
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.
    validate_on_origin_header_value str
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request's header value that corresponds to the validateOnOriginHeaderName.
    validate_on_origin_response_code int
    Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.
    validate_on_origin_with str
    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.
    allowLargePostBody Boolean
    Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
    cloudletPolicy 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.
    penalty403NetStoragePath String
    Specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.
    penaltyAction String
    Once the penaltyThreshold of invalid requests is met, this specifies the response.
    penaltyBrandedDenyCacheTtl Number
    Specifies the penalty response's time to live in the cache, 5 minutes by default.
    penaltyNetStorage Property Map
    Specifies the NetStorage account that serves out the penalty's static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.
    penaltyThreshold Number
    Specifies the number of invalid requests permitted before executing the penaltyAction.
    penaltyTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resetOnValid Boolean
    Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by specific HTTP headers on GET or POST requests.
    userIdentificationByIp Boolean
    When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
    userIdentificationByParams Boolean
    When enabled, identifies users by specific query parameters on GET or POST requests.
    userIdentificationKeyCookie String
    This specifies the cookie name whose value needs to remain constant across requests to identify a user.
    userIdentificationKeyHeaders List<String>
    This specifies the HTTP headers whose combined set of values identify each end user.
    userIdentificationKeyParams List<String>
    This specifies the query parameters whose combined set of values identify each end user.
    userIdentificationTitle 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.
    validateOnOriginHeaderName String
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.
    validateOnOriginHeaderValue String
    If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request's header value that corresponds to the validateOnOriginHeaderName.
    validateOnOriginResponseCode Number
    Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.
    validateOnOriginWith String
    For any validation that edge servers can't perform alone, this specifies additional validation steps based on how the origin identifies an invalid request. If a request is invalid, the origin can indicate this to the edge server.
    validationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230105BehaviorInstant

    CustomLinkRelations List<string>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions List<string>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLinkRelations []string
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions []string
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations string[]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions string[]
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_relations Sequence[str]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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 the tieredDistribution 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_store bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetch_no_store_extensions Sequence[str]
    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.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching string
    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.
    maximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid string
    This option is for internal usage only.
    useVersioning boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_object_caching str
    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 or GB. 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 or GB.
    template_uuid str
    This option is for internal usage only.
    use_versioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    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.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Integer
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Integer
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest number
    The number of POC fragments to prefetch during the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or GB suffix.
    prefetch_after_request int
    The number of POC fragments to prefetch after the request.
    prefetch_during_request int
    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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Number
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    BitrateTables List<GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables List<GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BitrateTables []GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateBitrateTable
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables []GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables List<GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables List<GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateBitrateTable[]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid string
    This option is for internal usage only.
    thresholdTables GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable[]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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[GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateBitrateTable]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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[GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    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.
    bitrateTables 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 numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables 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 numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue double
    The numeric indicator of the download rate.
    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue float64
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Double
    The numeric indicator of the download rate.
    bitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue number
    The numeric indicator of the download rate.
    bitrate_unit str
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrate_value float
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Number
    The numeric indicator of the download rate.

    GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable

    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Integer
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue 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, or BYTES of the file size.
    threshold_value int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Number
    The numeric indicator of the minimum file size or elapsed download time.

    GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom

    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_field str
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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_log_field bool
    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.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    apiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid string
    This option is for internal usage only.
    titleOptional 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}}". See Configuration 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges string
    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.
    hlsFilterInBitrates string
    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.
    hlsMode string
    Applies with hlsEnabled on.
    hlsPreferredBitrate string
    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.
    hlsQueryParamEnabled boolean
    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.
    hlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_debug_headers bool
    Includes additional Akamai-Manifest-Personalization and Akamai-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_in_bitrate_ranges str
    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_in_bitrates str
    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_bitrate str
    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_param_enabled bool
    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_param_secret_key str
    Specifies a primary key as a token to accompany the request.
    hls_query_param_transition_key str
    Specifies a transition key as a token to accompany the request.
    hls_show_advanced bool
    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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    beaconId 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.
    templateUuid string
    This option is for internal usage only.
    useHybridHttpUdp boolean
    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_http_udp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes []string
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes []string
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Integer
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Integer
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Integer
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse boolean
    When enabled, caches the error response.
    cacheWindow string
    This sets error response's TTL.
    clientResponseCode string
    Specifies the response code served to the client.
    detectObjectUnavailable boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost string
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery string
    This sets the recovery option.
    objectUnavailableRedirectMethod number
    Specifies a redirect response code.
    objectUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit string
    Sets how many times to retry.
    originUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost string
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath string
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath boolean
    Modifies the request path.
    originUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery string
    This sets the recovery option.
    originUnavailableRedirectMethod number
    Specifies either a redirect response code.
    originUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit string
    Sets how many times to retry.
    originUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost string
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath boolean
    Modifies the request path.
    originUnresponsiveProtocol string
    Specifies which protocol to use.
    originUnresponsiveRecovery string
    This sets the recovery option.
    originUnresponsiveRedirectMethod number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit string
    Sets how many times to retry.
    otherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response bool
    When enabled, caches the error response.
    cache_window str
    This sets error response's TTL.
    client_response_code str
    Specifies the response code served to the client.
    detect_object_unavailable bool
    Allows you to configure failover settings when the origin has content errors.
    detect_object_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    detect_origin_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    detect_origin_unresponsive_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.
    object_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    object_unavailable_backup_host str
    This specifies the origin hostname.
    object_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    object_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    object_unavailable_change_protocol bool
    Changes the request protocol.
    object_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    object_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    object_unavailable_modified_path str
    This specifies the path to form the new URL.
    object_unavailable_modify_request_path bool
    Enabling this allows you to modify the request path.
    object_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    object_unavailable_recovery str
    This sets the recovery option.
    object_unavailable_redirect_method int
    Specifies a redirect response code.
    object_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when there are content errors.
    object_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unavailable_backup_host str
    This specifies the origin hostname.
    origin_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unavailable_change_protocol bool
    Modifies the request protocol.
    origin_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    origin_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unavailable_modified_path str
    This specifies the path to form the new URL.
    origin_unavailable_modify_request_path bool
    Modifies the request path.
    origin_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    origin_unavailable_recovery str
    This sets the recovery option.
    origin_unavailable_redirect_method int
    Specifies either a redirect response code.
    origin_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when the origin responds with errors.
    origin_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unresponsive_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unresponsive_backup_host str
    This specifies the origin hostname.
    origin_unresponsive_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unresponsive_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unresponsive_change_protocol bool
    This allows you to change the request protocol.
    origin_unresponsive_detection_level str
    Specify the level of response to slow origin connections.
    origin_unresponsive_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unresponsive_modified_path str
    This specifies the path to form the new URL.
    origin_unresponsive_modify_request_path bool
    Modifies the request path.
    origin_unresponsive_protocol str
    Specifies which protocol to use.
    origin_unresponsive_recovery str
    This sets the recovery option.
    origin_unresponsive_redirect_method int
    Specifies the redirect response code.
    origin_unresponsive_retry_limit str
    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.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Number
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Number
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to_origin bool
    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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Supplies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Supplies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Specifies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies an HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies the new HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies the new HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption string
    Specify how you want to handle the header.
    renameHeaderTo string
    Specifies a new name to replace the existing Via header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to str
    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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities List<GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority>
    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.
    CustomCertificates List<GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificate>
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues List<string>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    NetStorage GetPropertyRulesBuilderRulesV20230105BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities List<string>
    TemplateUuid string
    This option is for internal usage only.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities []GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority
    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.
    CustomCertificates []GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificate
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues []string
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    NetStorage GetPropertyRulesBuilderRulesV20230105BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities []string
    TemplateUuid string
    This option is for internal usage only.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities List<GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority>
    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.
    customCertificates List<GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificate>
    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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Integer
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort 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. See Secure property requirements for guidance.
    ipVersion 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.
    netStorage GetPropertyRulesBuilderRulesV20230105BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Integer
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    compress boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority[]
    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.
    customCertificates GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificate[]
    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.
    customForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues string[]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    netStorage GetPropertyRulesBuilderRulesV20230105BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor string
    Specifies which certificate to trust.
    originId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace string
    Specifies replacement text for what saasRegex matches.
    saasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    saasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities string[]
    templateUuid string
    This option is for internal usage only.
    trueClientIpClientSetting boolean
    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.
    trueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey boolean
    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.
    verificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cache_key_hostname str
    Specifies the hostname to use when forming a cache key.
    compress bool
    Enables gzip compression for non-NetStorage origins.
    custom_certificate_authorities Sequence[GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority]
    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[GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificate]
    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_host_header str
    This specifies the name of the custom host header the edge server should pass to the origin.
    custom_valid_cn_values Sequence[str]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enable_true_client_ip bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forward_host_header str
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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. See Secure 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 GetPropertyRulesBuilderRulesV20230105BehaviorOriginNetStorage
    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_to_honor str
    Specifies which certificate to trust.
    origin_id str
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id 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.
    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_enabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saas_cname_level int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saas_query_string str
    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_enabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standard_certificate_authorities Sequence[str]
    template_uuid str
    This option is for internal usage only.
    true_client_ip_client_setting bool
    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_ip_header str
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    use_unique_cache_key bool
    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.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities 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.
    customCertificates 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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort Number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    netStorage Property Map
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics

    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings List<string>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    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.
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings []string
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    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.
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Integer
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    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.
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    accessKeyEncryptedStorage boolean
    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.
    adcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod string
    Specifies the authentication method.
    authenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings string[]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo string
    Provides a region used by Akamai Direct Connection.
    encodingVersion number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    gcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret string
    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.
    secretKey string
    Specifies the shared secret key.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    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_encrypted_storage bool
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    aws_access_key_id str
    Specifies active access key ID linked to your AWS account.
    aws_access_key_version_guid str
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    aws_host str
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    aws_region str
    This specifies the AWS region code of the location where your bucket resides.
    aws_secret_access_key str
    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_strings Sequence[str]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    direct_connect_geo str
    Provides a region used by Akamai Direct Connection.
    encoding_version int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    gcs_access_key_version_guid str
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcs_hmac_key_access_id str
    Specifies the active access ID linked to your Google account.
    gcs_hmac_key_secret str
    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_sign_string bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    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.
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthorityIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthoritySubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateSubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod

    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode string
    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.
    recoveryMethod string
    Specifies the recovery method.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_code str
    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.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Integer
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Integer
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Integer
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    binaryEquivalentContent boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval number
    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.
    monitorOriginResponsiveness boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    tuningParameters 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_content bool
    Synchronizes content between the primary and backup origins, byte for byte.
    enable_ip_avoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled bool
    Activates and configures a recovery policy.
    ip_avoidance_error_threshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ip_avoidance_retry_interval int
    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_responsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitor_response_codes1s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes2s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes3s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitor_status_codes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes1_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes1_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes1_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes2_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes2_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes2_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes3_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes3_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes3_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_custom_timeout int
    Specify a custom timeout, from 1 to 10 seconds.
    origin_responsiveness_enable_recovery bool
    Enables a recovery action for a specific failure condition.
    origin_responsiveness_enable_retry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    origin_responsiveness_monitoring str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    origin_responsiveness_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_timeout str
    The timeout threshold that triggers a retry or recovery action.
    status_code_monitoring1 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring2 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring3 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.
    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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Number
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    cpCode Integer
    downloadDomainName String
    g2oToken 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes List<string>
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle 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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes []string
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle 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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle 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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    enabled boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes string[]
    Defines the set of failure codes that initiate the failover response.
    failoverTitle 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.
    populationCookieType 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 effectively NONE.
    populationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate string
    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.
    populationRefresh boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105BehaviorPhasedReleaseCloudletPolicy
    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_codes Sequence[str]
    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.
    population_cookie_type 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 effectively NONE.
    population_duration str
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    population_expiration_date str
    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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle 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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorPhasedReleaseCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorPreconnect

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Preconnectlists List<string>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Preconnectlists []string
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists string[]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists Sequence[str]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorPredictiveContentDelivery

    Enabled bool
    Enables the predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorPredictivePrefetching

    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled boolean
    Enables the predictive prefetching 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracy_target str
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled bool
    Enables the predictive prefetching 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.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorPrefetch

    Enabled bool
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorPrefetchable

    Enabled bool
    Allows matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked bool
    Indicates that your 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorPrefreshCache

    Enabled bool
    Enables the cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval Integer
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    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 cache prefreshing 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.
    prefreshval Number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorQuality

    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Integer
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize string
    contentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType string
    country string
    deliveryFormat string
    deliveryType string
    downloadType string
    endUserLocation 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.
    maximumConcurrentUsers string
    objectSize string
    optimizeFor string
    originSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution string
    refreshRate string
    segmentDuration number
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audience_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalog_size str
    content_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    content_type str
    country str
    delivery_format str
    delivery_type str
    download_type str
    end_user_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.
    maximum_concurrent_users str
    object_size str
    optimize_for str
    origin_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularity_distribution str
    refresh_rate str
    segment_duration int
    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.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Number
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorQuicBeta

    Enabled bool
    Enables QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Integer
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quic_offer_percentage int
    The percentage of responses for which to allow QUIC sessions.
    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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRandomSeek

    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv boolean
    Enables random seek optimization in FLV files.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 boolean
    Enables random seek optimization in MP4 files.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv bool
    Enables random seek optimization in FLV files.
    locked bool
    Indicates 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
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 bool
    Enables random seek optimization in MP4 files.
    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.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRapid

    Enabled bool
    Enables API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorReadTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked bool
    Indicates that your 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.

    GetPropertyRulesBuilderRulesV20230105BehaviorRealTimeReporting

    Advanced bool
    Enables advanced options.
    BeaconSamplingPercentage double
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    BeaconSamplingPercentage float64
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage Double
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage number
    Specifies the percentage for sampling.
    enabled boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beacon_sampling_percentage float
    Specifies the percentage for sampling.
    enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked bool
    Indicates that your 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.
    advanced Boolean
    Enables advanced options.
    beaconSamplingPercentage Number
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRealUserMonitoring

    Enabled bool
    When enabled, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked bool
    Indicates that your 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRedirect

    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Integer
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol string
    Choose the protocol for the redirect URL.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    queryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode number
    Specify the redirect's response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination_hostname str
    Specify how to change the requested hostname, independently from the pathname.
    destination_hostname_other str
    Specifies the full hostname with which to replace the current hostname.
    destination_hostname_sibling str
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destination_hostname_subdomain str
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destination_path str
    Specify how to change the requested pathname, independently from the hostname.
    destination_path_other str
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destination_path_prefix str
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destination_path_suffix str
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destination_path_suffix_status str
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destination_protocol str
    Choose the protocol for the redirect URL.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobile_default_choice str
    Either specify a default response for mobile browsers, or customize your own.
    query_string str
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    response_code int
    Specify the redirect's 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.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Number
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRedirectplus

    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Integer
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled boolean
    Enables the redirect 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.
    responseCode number
    Assigns the status code for the redirect response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination str
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled bool
    Enables the redirect 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.
    response_code int
    Assigns the status code for the redirect 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.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Number
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRefererChecking

    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains List<string>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains []string
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains string[]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled boolean
    Enables the referer-checking 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.
    strict boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_children bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains Sequence[str]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled bool
    Enables the referer-checking 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.
    strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    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.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRemoveQueryParameter

    Locked bool
    Indicates 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 parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Parameters []string
    Specifies parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters List<String>
    Specifies parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters string[]
    Specifies parameters to remove from the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters Sequence[str]
    Specifies parameters to remove from 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.
    locked Boolean
    Indicates 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 parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRemoveVary

    Enabled bool
    When enabled, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked bool
    Indicates that your 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorReport

    Cookies List<string>
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Cookies []string
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies string[]
    This specifies the set of cookies names whose values you want to log.
    customLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage boolean
    Log the Accept-Language header.
    logCookies string
    Specifies the set of cookies to log.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    logEdgeIp boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost boolean
    Log the Host header.
    logReferer boolean
    Log the Referer header.
    logUserAgent boolean
    Log the User-Agent header.
    logXForwardedFor boolean
    Log any X-Forwarded-For request header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies Sequence[str]
    This specifies the set of cookies names whose values you want to log.
    custom_log_field str
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked bool
    Indicates 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_accept_language bool
    Log the Accept-Language header.
    log_cookies str
    Specifies the set of cookies to log.
    log_custom_log_field bool
    Whether to append additional custom data to each log line.
    log_edge_ip bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    log_host bool
    Log the Host header.
    log_referer bool
    Log the Referer header.
    log_user_agent bool
    Log the User-Agent header.
    log_x_forwarded_for bool
    Log any X-Forwarded-For request 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.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRequestControl

    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    NetStorage GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    NetStorage GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Integer
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Integer
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    netStorage GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode number
    Specifies the response status code for the branded deny action.
    branded403Url string
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    enableBranded403 boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled boolean
    Enables the Request Control Cloudlet.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    netStorage GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403_file str
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403_status_code int
    Specifies the response status code for the branded deny action.
    branded403_url str
    Specifies the redirect URL for the branded deny action.
    branded_deny_cache_ttl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    enable_branded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled bool
    Enables the Request Control Cloudlet.
    locked bool
    Indicates 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 GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    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.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Number
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    netStorage Property Map
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorRequestControlNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230105BehaviorRequestTypeMarker

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType string
    Specifies the type of request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    request_type str
    Specifies the type of 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizer

    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorResourceOptimizerExtendedCompatibility

    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures boolean
    Enables additional support and error handling.
    enabled boolean
    Enables the Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_all_features bool
    Enables additional support and error handling.
    enabled bool
    Enables the Resource Optimizer 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.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Integer
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode number
    The HTTP status code to replace the existing one.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    status_code int
    The HTTP status code to replace the existing one.
    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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Number
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorResponseCookie

    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled boolean
    Allows you to set a response cookie.
    expirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires string
    Sets various ways to specify when the cookie expires.
    format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid string
    This option is for internal usage only.
    type string
    What type of value to assign.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookie_name str
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    default_domain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    default_path bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain str
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration str
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled bool
    Allows you to set a response cookie.
    expiration_date str
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires str
    Sets various ways to specify when the cookie expires.
    format str
    When the type of cookie is set to UNIQUE, this sets the date format.
    http_only bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path str
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    same_site str
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    template_uuid str
    This option is for internal usage only.
    type str
    What type of value to assign.
    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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.

    GetPropertyRulesBuilderRulesV20230105BehaviorRestrictObjectCaching

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_size str
    Specifies a fixed maximum size of non-HTML content to cache.
    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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorReturnCacheStatus

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    response_header_name str
    Specifies the name of the HTTP header in which to report the cache status 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRewriteUrl

    Behavior string
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString boolean
    When enabled, retains the original path's query parameters.
    locked boolean
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keep_query_string bool
    When enabled, retains the original path's query parameters.
    locked bool
    Indicates 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 str
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    match_multiple bool
    When enabled, replaces all potential matches rather than only the first.
    match_regex str
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    target_path str
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    target_path_prepend str
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    target_regex str
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    target_url str
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorRumCustom

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Integer
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rum_group_name str
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rum_sample_rate int
    Specifies the percentage of web traffic to include in your RUM 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSaasDefinitions

    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    applicationAction string
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie string
    This specifies the name of the cookie that identifies the application.
    applicationQueryString string
    This names the query parameter that identifies the application.
    applicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction string
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie string
    This specifies the name of the cookie that identifies the customer.
    customerQueryString string
    This names the query parameter that identifies the customer.
    customerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid string
    This option is for internal usage only.
    usersAction string
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie string
    This specifies the name of the cookie that identifies the user.
    usersQueryString string
    This names the query parameter that identifies the user.
    usersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    application_action str
    Specifies the request component that identifies a SaaS application.
    application_cname_enabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    application_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    application_cookie str
    This specifies the name of the cookie that identifies the application.
    application_query_string str
    This names the query parameter that identifies the application.
    application_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    application_replace str
    Specifies a string to replace the request's application ID matched by applicationRegex.
    application_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customer_action str
    Specifies the request component that identifies a SaaS customer.
    customer_cname_enabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customer_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    customer_cookie str
    This specifies the name of the cookie that identifies the customer.
    customer_query_string str
    This names the query parameter that identifies the customer.
    customer_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customer_replace str
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customer_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.
    users_action str
    Specifies the request component that identifies a SaaS user.
    users_cname_enabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    users_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    users_cookie str
    This specifies the name of the cookie that identifies the user.
    users_query_string str
    This names the query parameter that identifies the user.
    users_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    users_replace str
    Specifies a string to replace the request's user ID matched by usersRegex.
    users_title 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.

    GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudClient

    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader string
    Specifies where the Host header is defined.
    originType string
    Specifies where the origin is.
    sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_override_origin_cache_key bool
    When enabled, overrides the forwarding origin's cache key.
    connector_id str
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked bool
    Indicates 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_host_header str
    Specifies where the Host header is defined.
    origin_type str
    Specifies where the origin is.
    sf3c_origin_host str
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3c_origin_host_header str
    This specifies the hostname or IP address of the custom Salesforce host 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.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProvider

    Enabled bool
    Enables Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked bool
    Indicates that your 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSalesForceCommerceCloudProviderHostHeader

    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource string
    Specify where the host header derives 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    host_header_source str
    Specify where the host header derives 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.
    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.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSavePostDcaProcessing

    Enabled bool
    Enables processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    enabled Boolean
    Enables processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorScheduleInvalidation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod string
    Specifies how to invalidate the content.
    repeat boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start string
    The UTC date and time when matching cached content is to expire.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refresh_method str
    Specifies how to invalidate the content.
    repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeat_interval str
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start str
    The UTC date and time when matching cached content is to expire.
    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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorScriptManagement

    Enabled bool
    Enables the Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Integer
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid string
    This option is for internal usage only.
    timestamp number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker str
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    template_uuid str
    This option is for internal usage only.
    timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedContentProtection

    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts List<string>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles List<string>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts []string
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles []string
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Integer
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption boolean
    Whether to enable DASH Media Encryption.
    dataPayload boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled boolean
    Enables the segmented content protection behavior.
    fieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts string[]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles string[]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption boolean
    Enables HLS Segment Encryption.
    ip boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid string
    This option is for internal usage only.
    tokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dash_media_encryption bool
    Whether to enable DASH Media Encryption.
    data_payload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enable_token_in_uri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled bool
    Enables the segmented content protection behavior.
    field_carry_over str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    header_for_salts Sequence[str]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hls_master_manifest_files Sequence[str]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hls_media_encryption bool
    Enables HLS Segment Encryption.
    ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key str
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked bool
    Indicates 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_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revoked_list_id int
    Identifies the TokenAuth tokens to block from accessing your content.
    salt str
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    session_id bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    template_uuid str
    This option is for internal usage only.
    token_auth_hls_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_authentication_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_revocation_enabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    token_revocation_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transition_key str
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    use_advanced bool
    Allows you to specify advanced transitionKey and salt options.
    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.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaOptimization

    Behavior string
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType string
    The type of DVR.
    dvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime string
    This specifies when the live media event ends.
    liveType string
    The type of live 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.
    showAdvanced boolean
    Allows you to configure advanced media options.
    startTime string
    This specifies when the live media event begins.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvr_type str
    The type of DVR.
    dvr_window str
    Set the duration for your media, or 0m if a DVR is not required.
    enable_ull_streaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    end_time str
    This specifies when the live media event ends.
    live_type str
    The type of live 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.
    show_advanced bool
    Allows you to configure advanced media options.
    start_time str
    This specifies when the live media event begins.
    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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSegmentedMediaStreamingPrefetch

    Enabled bool
    Enables media stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked bool
    Indicates that your 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSetVariable

    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex string
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber string
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber string
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex string
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex string
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber string
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber string
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex string
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex String
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Integer
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Integer
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Integer
    Specifies a maximum value for the generated integer.
    maxRandomNumber String
    Specifies the upper bound of the random number.
    min Integer
    Specifies a minimum value for the generated integer.
    minRandomNumber String
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Integer
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex String
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm string
    Specifies the algorithm to apply.
    caseSensitive boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName string
    Specifies the certificate's content.
    cookieName string
    Specifies the name of the cookie to extract.
    deviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode string
    Specifies the encryption mode.
    endIndex string
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation string
    This specifies from where to get the value.
    forceChars string
    Specifies characters to encode, possibly overriding the default set.
    formatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator string
    This specifies the type of value to generate.
    globalSubstitution boolean
    Replaces all matches in the string, not just the first.
    headerName string
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion string
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked boolean
    Indicates 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 number
    Specifies a maximum value for the generated integer.
    maxRandomNumber string
    Specifies the upper bound of the random number.
    min number
    Specifies a minimum value for the generated integer.
    minRandomNumber string
    Specifies the lower bound of the random number.
    nonce string
    Specifies the one-time number used for encryption.
    numberOfBytes number
    Specifies the number of random hex bytes to generate.
    operandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    separator string
    Specifies the character that separates pairs of values within the string.
    setCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    startIndex string
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid string
    This option is for internal usage only.
    transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource string
    Determines how you want to set the value.
    variableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm str
    Specifies the algorithm to apply.
    case_sensitive bool
    Enabling this makes all matches case sensitive.
    certificate_field_name str
    Specifies the certificate's content.
    cookie_name str
    Specifies the name of the cookie to extract.
    device_profile str
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryption_key str
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryption_mode str
    Specifies the encryption mode.
    end_index str
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    except_chars str
    Specifies characters not to encode, possibly overriding the default set.
    extract_location str
    This specifies from where to get the value.
    force_chars str
    Specifies characters to encode, possibly overriding the default set.
    format_string str
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator str
    This specifies the type of value to generate.
    global_substitution bool
    Replaces all matches in the string, not just the first.
    header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    hmac_algorithm str
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmac_key str
    Specifies the secret to use in generating the base64-encoded digest.
    initialization_vector str
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ip_version str
    Specifies the IP version under which a subnet mask generates.
    ipv4_prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6_prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    location_id str
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    max_random_number str
    Specifies the upper bound of the random number.
    min int
    Specifies a minimum value for the generated integer.
    min_random_number str
    Specifies the lower bound of the random number.
    nonce str
    Specifies the one-time number used for encryption.
    number_of_bytes int
    Specifies the number of random hex bytes to generate.
    operand_one str
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    param_name str
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    path_component_offset str
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prepend_bytes bool
    Specifies a number of random bytes to prepend to the key.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the value.
    regex str
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement str
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    response_header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    separator str
    Specifies the character that separates pairs of values within the string.
    set_cookie_name str
    Specifies the name of the origin's Set-Cookie response header.
    start_index str
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    sub_string str
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    template_uuid str
    This option is for internal usage only.
    transform str
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    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_source str
    Determines how you want to set the value.
    variable_name str
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variable_value str
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex String
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Number
    Specifies a maximum value for the generated integer.
    maxRandomNumber String
    Specifies the upper bound of the random number.
    min Number
    Specifies a minimum value for the generated integer.
    minRandomNumber String
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Number
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex String
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.

    GetPropertyRulesBuilderRulesV20230105BehaviorShutr

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Status string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Status string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    status String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    status string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    status 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.
    status String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSimulateErrorCode

    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType string
    Specifies the type of 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.
    templateUuid string
    This option is for internal usage only.
    timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    error_type str
    Specifies the type of 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.
    timeout str
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    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.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSiteShield

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20230105BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20230105BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230105BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230105BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230105BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap Property Map
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorSiteShieldSsmap

    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String
    chinaCdnMap string
    hasMixedHosts boolean
    name string
    src string
    srmap string
    value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String

    GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigration

    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Integer
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Integer
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration number
    Specifies the number cache sharing days.
    cacheSharingStartTime string
    Specifies when to start cache sharing.
    enabled boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration number
    Specifies the number of days to migrate the cache.
    migrationFrom string
    What kind of traffic you're migrating from.
    migrationStartTime string
    Specifies when to start migrating the cache.
    tdLocation string
    Specifies the tieredDistribution location.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_https_downgrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allow_https_upgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cache_sharing_duration int
    Specifies the number cache sharing days.
    cache_sharing_start_time str
    Specifies when to start cache sharing.
    enabled bool
    Allows migration to Standard TLS.
    is_certificate_sni_only bool
    Sets whether your new certificate is SNI-only.
    is_tiered_distribution_used bool
    Allows you to align traffic to various tieredDistribution areas.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migration_duration int
    Specifies the number of days to migrate the cache.
    migration_from str
    What kind of traffic you're migrating from.
    migration_start_time str
    Specifies when to start migrating the cache.
    td_location str
    Specifies the tieredDistribution location.
    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.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Number
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Number
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorStandardTlsMigrationOverride

    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorStrictHeaderParsing

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strict_mode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers 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.
    valid_mode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.

    GetPropertyRulesBuilderRulesV20230105BehaviorSubCustomer

    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey boolean
    Allows you to set which query parameters are included in the cache key.
    caching boolean
    Modifies content caching rules.
    contentCompressor boolean
    Allows compression of subcustomer content.
    dynamicWebContent boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery boolean
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery boolean
    Enables delivery of media assets to subcustomers.
    origin boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid string
    This option is for internal usage only.
    tokenAuthorization boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    access_control bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cache_key bool
    Allows you to set which query parameters are included in the cache key.
    caching bool
    Modifies content caching rules.
    content_compressor bool
    Allows compression of subcustomer content.
    dynamic_web_content bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geo_location bool
    Sets subcustomers' location-based whitelists or blacklists.
    ip bool
    Sets subcustomers' IP whitelists or blacklists.
    large_file_delivery bool
    Enables large file delivery for subcustomers.
    live_video_delivery bool
    locked bool
    Indicates 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_path bool
    Modifies a subcustomer's request path.
    on_demand_video_delivery bool
    Enables delivery of media assets to subcustomers.
    origin bool
    Allows you to assign origin hostnames for customers.
    partner_domain_suffix str
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    refresh_content bool
    Allows you to reschedule when content validates for subcustomers.
    site_failover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    template_uuid str
    This option is for internal usage only.
    token_authorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    web_application_firewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.

    GetPropertyRulesBuilderRulesV20230105BehaviorSureRoute

    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride boolean
    customMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    testObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus string
    Specifies which hostname to use.
    type string
    Specifies the set of edge servers used to test routes.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_fcm_parent_override bool
    custom_map str
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    custom_stat_key str
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enable_custom_key bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    force_ssl_forward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    race_stat_ttl str
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    sr_download_link_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.
    test_object_url str
    Specifies the path and filename for your origin's test object to use in races to test routes.
    to_host str
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    to_host_status str
    Specifies which hostname to use.
    type str
    Specifies the set of edge servers used to test routes.
    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.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorTcpOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorTeaLeaf

    Enabled bool
    When enabled, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Integer
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibm_customer_id int
    The integer identifier for the IBM Tealeaf Connector account.
    limit_to_dynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistribution

    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked bool
    Indicates that your 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.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionAdvanced

    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall boolean
    enabled boolean
    When enabled, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method string
    policy string
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall bool
    enabled bool
    When enabled, activates tiered distribution.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method str
    policy str
    template_uuid str
    This option is for internal usage only.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorTieredDistributionCustomization

    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled boolean
    Enables custom maps.
    customMapName string
    Specifies the custom map name.
    hashAlgorithm string
    Specifies the hash algorithm.
    location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate string
    Specifies when the map migration should end.
    migrationStartDate string
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart string
    Specifies a numeric serial start value.
    templateUuid string
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapper_map_migration_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    custom_map_enabled bool
    Enables custom maps.
    custom_map_name str
    Specifies the custom map name.
    hash_algorithm str
    Specifies the hash algorithm.
    location str
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    map_migration_enabled bool
    Enables migration of the custom map to Cloud Wrapper.
    migration_end_date str
    Specifies when the map migration should end.
    migration_start_date str
    Specifies when to start migrating the map.
    migration_within_cw_maps_enabled bool
    Enables migration within Cloud Wrapper maps.
    serial_end str
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serial_start str
    Specifies a numeric serial start value.
    template_uuid str
    This option is for internal usage only.
    tier1_title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.

    GetPropertyRulesBuilderRulesV20230105BehaviorTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked bool
    Indicates that your 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.

    GetPropertyRulesBuilderRulesV20230105BehaviorUidConfiguration

    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled boolean
    Allows you to extract UIDs from client requests.
    extractLocation string
    Where to extract the UID value from.
    headerName string
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled bool
    Allows you to extract UIDs from client requests.
    extract_location str
    Where to extract the UID value from.
    header_name str
    This specifies the name of the HTTP header from which to extract the UID value.
    legal_text 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.
    query_parameter_name str
    This specifies the name of the query parameter from which to extract the UID 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 rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.

    GetPropertyRulesBuilderRulesV20230105BehaviorValidateEntityTag

    Enabled bool
    Enables the ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebToken

    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation string
    Specify from where to extract the JWT value.
    headerName string
    This specifies the name of the header from which to extract the JWT value.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extract_location str
    Specify from where to extract the JWT value.
    header_name str
    This specifies the name of the header from which to extract the JWT value.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates 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_name str
    This specifies the name of the query parameter from which to extract the JWT 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.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorVerifyJsonWebTokenForDcp

    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.
    authorizations string
    This specifies the authorization group name.
    clientId string
    This specifies the claim name.
    customHeader boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation string
    Specifies where to get the JWT value from.
    extractUserName boolean
    Allows you to extract the user name stored in the JWT.
    headerName string
    This specifies the name of the header to extract the JWT value from.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    userName string
    This specifies the user 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.
    authorizations str
    This specifies the authorization group name.
    client_id str
    This specifies the claim name.
    custom_header bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enable_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extract_authorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    extract_client_id bool
    Allows you to extract the client ID claim name stored in JWT.
    extract_location str
    Specifies where to get the JWT value from.
    extract_user_name bool
    Allows you to extract the user name stored in the JWT.
    header_name str
    This specifies the name of the header to extract the JWT value from.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primary_location str
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the JWT value.
    template_uuid str
    This option is for internal usage only.
    user_name str
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.

    GetPropertyRulesBuilderRulesV20230105BehaviorVerifyTokenAuthorization

    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location string
    Specifies where to find the token in the incoming request.
    locationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid string
    This option is for internal usage only.
    transitionKey string
    Specifies a transition key as a hex value.
    useAdvanced boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm str
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escape_hmac_inputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    failure_response bool
    When enabled, sends an HTTP error when an authentication test fails.
    ignore_query_string bool
    Enabling this removes the query string from the URL used to form an encryption key.
    key str
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location str
    Specifies where to find the token in the incoming request.
    location_id str
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt str
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    template_uuid str
    This option is for internal usage only.
    transition_key str
    Specifies a transition key as a hex value.
    use_advanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    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.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoom

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorVirtualWaitingRoomWithEdgeWorkers

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritization

    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders List<string>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams List<string>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders []string
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams []string
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Integer
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Integer
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Integer
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Integer
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Visitor Prioritization 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.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp boolean
    Allows IP addresses to identify users.
    userIdentificationByParams boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders string[]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams string[]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowed_user_cookie_advanced bool
    Sets advanced configuration options for the allowed user's cookie.
    allowed_user_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowed_user_cookie_domain str
    Specifies a domain for an allowed user cookie.
    allowed_user_cookie_domain_type str
    Specify with allowedUserCookieAdvanced enabled.
    allowed_user_cookie_duration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowed_user_cookie_enabled bool
    Sets a cookie for users who have been allowed through to the site.
    allowed_user_cookie_http_only bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowed_user_cookie_label str
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowed_user_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowed_user_cookie_refresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowed_user_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Visitor Prioritization 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.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by the values of GET or POST request headers.
    user_identification_by_ip bool
    Allows IP addresses to identify users.
    user_identification_by_params bool
    When enabled, identifies users by the values of GET or POST request parameters.
    user_identification_key_cookie str
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    user_identification_key_headers Sequence[str]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    user_identification_key_params Sequence[str]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    user_identification_title 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.
    waiting_room_cache_ttl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waiting_room_cookie_advanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waiting_room_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waiting_room_cookie_domain str
    Specifies a domain for the waiting room cookie.
    waiting_room_cookie_domain_type str
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waiting_room_cookie_duration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waiting_room_cookie_enabled bool
    Enables a cookie to track a waiting room assignment.
    waiting_room_cookie_http_only bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waiting_room_cookie_label str
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waiting_room_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waiting_room_cookie_share_label bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waiting_room_cp_code GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waiting_room_directory str
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waiting_room_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_net_storage GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waiting_room_status_code int
    Specifies the response code for requests sent to the waiting room.
    waiting_room_use_cp_code bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode Property Map
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage Property Map
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifo

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies how to set the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationFifoStandalone

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105BehaviorVisitorPrioritizationWaitingRoomNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230105BehaviorWatermarking

    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid string
    This option is for internal usage only.
    tokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 string
    Specifies a unique identifier for the first public key.
    verificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 string
    Specifies the first public key in its entirety.
    verificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    ab_variant_location str
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryption_password1 str
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryption_password2 str
    Provides the secondary password you can use to rotate passwords.
    decryption_password_id1 str
    Specifies a label that corresponds to the primary password.
    decryption_password_id2 str
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable bool
    Enables the watermarking 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.
    miscellaneous_settings_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    pattern_decryption_enable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    pattern_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signature_verification_enable bool
    When enabled, you can verify the signature in your watermarking token.
    template_uuid str
    This option is for internal usage only.
    token_signing_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    use_original_as_a bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    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_key_id1 str
    Specifies a unique identifier for the first public key.
    verification_key_id2 str
    Specifies a unique identifier for the optional second public key.
    verification_public_key1 str
    Specifies the first public key in its entirety.
    verification_public_key2 str
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.

    GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewall

    FirewallConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FirewallConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewall_configuration GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    firewallConfiguration Property Map
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorWebApplicationFirewallFirewallConfiguration

    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Integer
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId number
    fileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    config_id int
    file_name str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Number
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior

    GetPropertyRulesBuilderRulesV20230105BehaviorWebSockets

    Enabled bool
    Enables WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105BehaviorWebdav

    Enabled bool
    Enables the WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105Criterion

    AdvancedImMatch GetPropertyRulesBuilderRulesV20230105CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20230105CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20230105CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20230105CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20230105CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20230105CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20230105CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20230105CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20230105CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20230105CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20230105CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20230105CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20230105CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20230105CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20230105CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20230105CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20230105CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20230105CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20230105CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20230105CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20230105CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20230105CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20230105CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20230105CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20230105CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20230105CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20230105CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20230105CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20230105CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20230105CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20230105CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20230105CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20230105CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20230105CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20230105CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20230105CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20230105CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20230105CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20230105CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230105CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230105CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    AdvancedImMatch GetPropertyRulesBuilderRulesV20230105CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20230105CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20230105CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20230105CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20230105CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20230105CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20230105CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20230105CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20230105CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20230105CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20230105CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20230105CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20230105CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20230105CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20230105CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20230105CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20230105CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20230105CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20230105CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20230105CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20230105CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20230105CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20230105CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20230105CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20230105CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20230105CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20230105CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20230105CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20230105CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20230105CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20230105CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20230105CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20230105CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20230105CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20230105CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20230105CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20230105CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20230105CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20230105CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230105CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230105CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20230105CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230105CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230105CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20230105CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20230105CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20230105CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20230105CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20230105CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20230105CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20230105CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20230105CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20230105CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20230105CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20230105CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20230105CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230105CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230105CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20230105CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20230105CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20230105CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20230105CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20230105CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230105CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20230105CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230105CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20230105CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20230105CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20230105CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20230105CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20230105CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20230105CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20230105CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20230105CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230105CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20230105CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20230105CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20230105CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20230105CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20230105CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230105CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230105CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20230105CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230105CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230105CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20230105CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20230105CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20230105CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20230105CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20230105CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20230105CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20230105CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20230105CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20230105CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20230105CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20230105CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20230105CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230105CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230105CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20230105CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20230105CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20230105CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20230105CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20230105CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230105CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20230105CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230105CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20230105CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20230105CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20230105CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20230105CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20230105CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20230105CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20230105CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20230105CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230105CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20230105CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20230105CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20230105CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20230105CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20230105CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230105CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230105CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advanced_im_match GetPropertyRulesBuilderRulesV20230105CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230105CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230105CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    china_cdn_region GetPropertyRulesBuilderRulesV20230105CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    client_certificate GetPropertyRulesBuilderRulesV20230105CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    client_ip GetPropertyRulesBuilderRulesV20230105CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    client_ip_version GetPropertyRulesBuilderRulesV20230105CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudlets_origin GetPropertyRulesBuilderRulesV20230105CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    content_delivery_network GetPropertyRulesBuilderRulesV20230105CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    content_type GetPropertyRulesBuilderRulesV20230105CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    device_characteristic GetPropertyRulesBuilderRulesV20230105CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmd_auth_groups GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmd_auth_scheme GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmd_is_authenticated GetPropertyRulesBuilderRulesV20230105CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmd_username GetPropertyRulesBuilderRulesV20230105CriterionEcmdUsername
    This criterion can be used in includes.
    edge_workers_failure GetPropertyRulesBuilderRulesV20230105CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    file_extension GetPropertyRulesBuilderRulesV20230105CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230105CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230105CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    match_advanced GetPropertyRulesBuilderRulesV20230105CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    match_cp_code GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    match_response_code GetPropertyRulesBuilderRulesV20230105CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    match_variable GetPropertyRulesBuilderRulesV20230105CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadata_stage GetPropertyRulesBuilderRulesV20230105CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    origin_timeout GetPropertyRulesBuilderRulesV20230105CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230105CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    query_string_parameter GetPropertyRulesBuilderRulesV20230105CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230105CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recovery_config GetPropertyRulesBuilderRulesV20230105CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regular_expression GetPropertyRulesBuilderRulesV20230105CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    request_cookie GetPropertyRulesBuilderRulesV20230105CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    request_header GetPropertyRulesBuilderRulesV20230105CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    request_method GetPropertyRulesBuilderRulesV20230105CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    request_protocol GetPropertyRulesBuilderRulesV20230105CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    request_type GetPropertyRulesBuilderRulesV20230105CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    response_header GetPropertyRulesBuilderRulesV20230105CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230105CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    token_authorization GetPropertyRulesBuilderRulesV20230105CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    user_agent GetPropertyRulesBuilderRulesV20230105CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    user_location GetPropertyRulesBuilderRulesV20230105CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    user_network GetPropertyRulesBuilderRulesV20230105CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variable_error GetPropertyRulesBuilderRulesV20230105CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtual_waiting_room_request GetPropertyRulesBuilderRulesV20230105CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitor_prioritization_request GetPropertyRulesBuilderRulesV20230105CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch Property Map
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket Property Map
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability Property Map
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion Property Map
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate Property Map
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp Property Map
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion Property Map
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin Property Map
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork Property Map
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType Property Map
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic Property Map
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups Property Map
    This criterion can be used in includes.
    ecmdAuthScheme Property Map
    This criterion can be used in includes.
    ecmdIsAuthenticated Property Map
    This criterion can be used in includes.
    ecmdUsername Property Map
    This criterion can be used in includes.
    edgeWorkersFailure Property Map
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension Property Map
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename Property Map
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname Property Map
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced Property Map
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode Property Map
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode Property Map
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable Property Map
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage Property Map
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout Property Map
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path Property Map
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter Property Map
    Matches query string field names or values. This criterion can be used in includes.
    random Property Map
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig Property Map
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression Property Map
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie Property Map
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod Property Map
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol Property Map
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType Property Map
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    time Property Map
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization Property Map
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent Property Map
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation Property Map
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork Property Map
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError Property Map
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest Property Map
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest Property Map
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.

    GetPropertyRulesBuilderRulesV20230105CriterionAdvancedImMatch

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the match's scope.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the match's scope.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionBucket

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage Integer
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage number
    Specifies the percentage of requests to match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage int
    Specifies the percentage of requests to match.
    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.
    percentage Number
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionCacheability

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    match_operator str
    Specifies the match's logic.
    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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_CACHE).

    GetPropertyRulesBuilderRulesV20230105CriterionChinaCdnRegion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionClientCertificate

    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    isCertificatePresent boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    is_certificate_present bool
    Executes rule behaviors only if a client certificate authenticates requests.
    is_certificate_valid str
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked bool
    Indicates that your 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.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionClientIp

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    IP or CIDR block, for example: 71.92.0.0/14.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    useHeaders boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked bool
    Indicates 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_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    template_uuid str
    This option is for internal usage only.
    use_headers bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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.
    values Sequence[str]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.

    GetPropertyRulesBuilderRulesV20230105CriterionClientIpVersion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    useXForwardedFor boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked bool
    Indicates that your 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_x_forwarded_for bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.

    GetPropertyRulesBuilderRulesV20230105CriterionCloudletsOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The Cloudlets Origins identifier, limited to alphanumeric and underscore 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionContentDeliveryNetwork

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network string
    Match the network.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network str
    Match the network.
    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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionContentType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Content-Type response header value, for example text/html.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for all values.
    matchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Content-Type response header value, for example text/html.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for all values.
    match_operator str
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    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.
    values Sequence[str]
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.

    GetPropertyRulesBuilderRulesV20230105CriterionDeviceCharacteristic

    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues List<string>
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues []string
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Integer
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic string
    Aspect of the device or browser 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.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues string[]
    When the characteristic expects a string, this specifies the set of values.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue string
    When the characteristic expects a version number, this specifies it as a string.
    boolean_value bool
    When the characteristic expects a boolean value, this specifies the value.
    characteristic str
    Aspect of the device or browser 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_case_sensitive bool
    Sets a case-sensitive match for the stringValue field.
    match_wildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numeric_match_operator str
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numeric_value int
    When the characteristic expects a numeric value, this specifies the number.
    string_match_operator str
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    string_values Sequence[str]
    When the characteristic expects a string, this specifies the set of values.
    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.
    version_match_operator str
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    version_value str
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.

    GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthGroups

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked bool
    Indicates 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_operator 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.
    value str
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230105CriterionEcmdAuthScheme

    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    auth_scheme 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.
    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.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionEcmdIsAuthenticated

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionEcmdUsername

    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    match_operator 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.
    value str
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230105CriterionEdgeWorkersFailure

    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus string
    Specify execution status.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    exec_status str
    Specify execution status.
    locked bool
    Indicates that your 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.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionFileExtension

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.

    GetPropertyRulesBuilderRulesV20230105CriterionFilename

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the values field.
    matchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the values field.
    match_operator str
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    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.
    values Sequence[str]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.

    GetPropertyRulesBuilderRulesV20230105CriterionHostname

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked bool
    Indicates 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_operator str
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.

    GetPropertyRulesBuilderRulesV20230105CriterionMatchAdvanced

    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml string
    An XML string that closes the relevant block.
    description string
    A 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.
    openXml string
    An XML string that opens the relevant block.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    close_xml str
    An XML string that closes the relevant block.
    description str
    A 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.
    open_xml str
    An XML string that opens the relevant block.
    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.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to match the CP code, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230105CriterionMatchCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230105CriterionMatchResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A set of response codes to match, for example ["404","500"].
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator string
    Matches numeric range or a specified set of values.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A set of response codes to match, for example ["404","500"].
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    match_operator str
    Matches numeric range or a specified set of values.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    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.
    values Sequence[str]
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].

    GetPropertyRulesBuilderRulesV20230105CriterionMatchVariable

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues List<string>
    Specifies an array of matching strings.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues []string
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound string
    Specifies the range's numeric minimum value.
    matchCaseSensitive boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound string
    Specifies the range's numeric maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression string
    Specifies a single matching string.
    variableName string
    The name of the variable to match.
    variableValues string[]
    Specifies an array of matching strings.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound str
    Specifies the range's numeric minimum value.
    match_case_sensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    match_operator str
    The type of match, based on which you use different options to specify the match criteria.
    match_wildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound str
    Specifies the range's numeric maximum value.
    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_expression str
    Specifies a single matching string.
    variable_name str
    The name of the variable to match.
    variable_values Sequence[str]
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.

    GetPropertyRulesBuilderRulesV20230105CriterionMetadataStage

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Compares the current rule with the specified metadata stage.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked bool
    Indicates 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_operator str
    Compares the current rule with the specified metadata stage.
    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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.

    GetPropertyRulesBuilderRulesV20230105CriterionOriginTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specifies a single required ORIGIN_TIMED_OUT 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionPath

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of the values array.
    normalize boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of the values array.
    normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    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.
    values Sequence[str]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.

    GetPropertyRulesBuilderRulesV20230105CriterionQueryStringParameter

    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The value of the query field, for example, string in ?q=string.
    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.
    escapeValue boolean
    Matches when the value is URL-escaped.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName string
    The name of the query field, for example, q in ?q=string.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The value of the query field, for example, string in ?q=string.
    escape_value bool
    Matches when the value is URL-escaped.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the parameterName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameter_name str
    The name of the query field, for example, q in ?q=string.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.

    GetPropertyRulesBuilderRulesV20230105CriterionRandom

    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket Integer
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    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.
    bucket Number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionRecoveryConfig

    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    config_name str
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked bool
    Indicates that your 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.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionRegularExpression

    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive boolean
    Sets a case-sensitive regular expression 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.
    matchString string
    The string to match, typically the contents of a dynamic variable.
    regex string
    The regular expression (PCRE) to match against the string.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    case_sensitive bool
    Sets a case-sensitive regular expression 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_string str
    The string to match, typically the contents of a dynamic variable.
    regex str
    The regular expression (PCRE) to match against the string.
    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.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionRequestCookie

    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookie_name str
    The name of the cookie, for example, visitor in visitor:anon.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the cookieName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.

    GetPropertyRulesBuilderRulesV20230105CriterionRequestHeader

    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName string
    The name of the request header, for example Accept-Language.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    header_name str
    The name of the request header, for example Accept-Language.
    locked bool
    Indicates 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_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more 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.
    values Sequence[str]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.

    GetPropertyRulesBuilderRulesV20230105CriterionRequestMethod

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked bool
    Indicates 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_operator str
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.

    GetPropertyRulesBuilderRulesV20230105CriterionRequestProtocol

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked bool
    Indicates that your 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.

    GetPropertyRulesBuilderRulesV20230105CriterionRequestType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked bool
    Indicates 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_operator str
    Specifies whether the request IS or IS_NOT the type of specified 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.
    value str
    Specifies the type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.

    GetPropertyRulesBuilderRulesV20230105CriterionResponseHeader

    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName string
    The name of the response header, for example Content-Type.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator string
    Narrows the match according to various criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    header_name str
    The name of the response header, for example Content-Type.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_value bool
    When enabled, the match is case-sensitive for the value field.
    match_operator str
    Narrows the match according to various criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.

    GetPropertyRulesBuilderRulesV20230105CriterionTime

    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate string
    Sets the start of a time period.
    endDate string
    Sets the end of a fixed time period.
    lastingDate string
    Sets the start of a fixed time period.
    lastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies how to define the range of time.
    repeatBeginDate string
    Sets the start of the initial time period.
    repeatDuration string
    Sets the duration of each repeating time period.
    repeatInterval string
    Sets the time between each repeating time period's starting points.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    apply_daylight_savings_time bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    begin_date str
    Sets the start of a time period.
    end_date str
    Sets the end of a fixed time period.
    lasting_date str
    Sets the start of a fixed time period.
    lasting_duration str
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked bool
    Indicates 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_operator str
    Specifies how to define the range of time.
    repeat_begin_date str
    Sets the start of the initial time period.
    repeat_duration str
    Sets the duration of each repeating time period.
    repeat_interval str
    Sets the time between each repeating time period's starting points.
    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.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionTokenAuthorization

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Error match scope.
    StatusLists List<string>
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Error match scope.
    StatusLists []string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Error match scope.
    statusLists string[]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Error match scope.
    status_lists Sequence[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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionUserAgent

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    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.
    values Sequence[str]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).

    GetPropertyRulesBuilderRulesV20230105CriterionUserLocation

    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues List<string>
    Continent codes.
    CountryValues List<string>
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues []string
    Continent codes.
    CountryValues []string
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps string
    Specifies which IP addresses determine the user's location.
    continentValues string[]
    Continent codes.
    countryValues string[]
    ISO 3166-1 country codes, such as US or CN.
    field string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    check_ips str
    Specifies which IP addresses determine the user's location.
    continent_values Sequence[str]
    Continent codes.
    country_values Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    field str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    region_values Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionUserNetwork

    BandwidthValues List<string>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues List<string>
    NetworkValues List<string>
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BandwidthValues []string
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues []string
    NetworkValues []string
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues string[]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps string
    Specifies which IP addresses determine the user's network.
    field string
    The type of information 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.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues string[]
    networkValues string[]
    Any set of specific networks.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidth_values Sequence[str]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    check_ips str
    Specifies which IP addresses determine the user's network.
    field str
    The type of information 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    network_type_values Sequence[str]
    network_values Sequence[str]
    Any set of specific networks.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionVariableError

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames List<string>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames []string
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames string[]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    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_names Sequence[str]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.

    GetPropertyRulesBuilderRulesV20230105CriterionVirtualWaitingRoomRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CriterionVisitorPrioritizationRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230105CustomOverride

    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override
    name string
    The name of a custom override
    overrideId string
    The ID of a custom override
    name str
    The name of a custom override
    override_id str
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override

    GetPropertyRulesBuilderRulesV20230105Variable

    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable
    description string
    The description for a variable
    hidden boolean
    Whether a variable should be hidden
    name string
    The name of a variable
    sensitive boolean
    States whether a variable contains sensitive information
    value string
    The value for a variable
    description str
    The description for a variable
    hidden bool
    Whether a variable should be hidden
    name str
    The name of a variable
    sensitive bool
    States whether a variable contains sensitive information
    value str
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable

    GetPropertyRulesBuilderRulesV20230530

    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors List<GetPropertyRulesBuilderRulesV20230530Behavior>
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions List<GetPropertyRulesBuilderRulesV20230530Criterion>
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20230530CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables List<GetPropertyRulesBuilderRulesV20230530Variable>
    A list of variables for a rule
    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors []GetPropertyRulesBuilderRulesV20230530Behavior
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions []GetPropertyRulesBuilderRulesV20230530Criterion
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20230530CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables []GetPropertyRulesBuilderRulesV20230530Variable
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride String
    XML metadata of the rule
    behaviors List<GetPropertyRulesBuilderRulesV20230530Behavior>
    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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<GetPropertyRulesBuilderRulesV20230530Criterion>
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20230530CustomOverride
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid String
    The UUID of a rule template
    uuid String
    The UUID of the rule
    variables List<GetPropertyRulesBuilderRulesV20230530Variable>
    A list of variables for a rule
    name string
    The name of a rule
    advancedOverride string
    XML metadata of the rule
    behaviors GetPropertyRulesBuilderRulesV20230530Behavior[]
    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
    criteriaLocked boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    criterions GetPropertyRulesBuilderRulesV20230530Criterion[]
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20230530CustomOverride
    XML metadata of the rule
    isSecure boolean
    States whether a rule is secure
    templateLink string
    The template link for the rule
    templateUuid string
    The UUID of a rule template
    uuid string
    The UUID of the rule
    variables GetPropertyRulesBuilderRulesV20230530Variable[]
    A list of variables for a rule
    name str
    The name of a rule
    advanced_override str
    XML metadata of the rule
    behaviors Sequence[GetPropertyRulesBuilderRulesV20230530Behavior]
    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_satisfy str
    States whether 'all' criteria need to match or 'any'
    criterions Sequence[GetPropertyRulesBuilderRulesV20230530Criterion]
    The list of criteria for a rule
    custom_override GetPropertyRulesBuilderRulesV20230530CustomOverride
    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[GetPropertyRulesBuilderRulesV20230530Variable]
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride 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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<Property Map>
    The list of criteria for a rule
    customOverride Property Map
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid 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

    GetPropertyRulesBuilderRulesV20230530Behavior

    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230530BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20230530BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20230530BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230530BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20230530BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20230530BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20230530BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20230530BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20230530BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20230530BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20230530BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20230530BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20230530BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20230530BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20230530BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20230530BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20230530BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20230530BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20230530BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20230530BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20230530BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20230530BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20230530BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20230530BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230530BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20230530BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20230530BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20230530BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20230530BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20230530BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20230530BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20230530BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20230530BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20230530BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20230530BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20230530BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20230530BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230530BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20230530BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20230530BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20230530BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20230530BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20230530BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20230530BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20230530BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20230530BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20230530BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20230530BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20230530BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20230530BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20230530BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20230530BehaviorEdgeWorker
    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.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230530BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20230530BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20230530BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20230530BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20230530BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20230530BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20230530BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20230530BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20230530BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230530BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230530BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20230530BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20230530BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20230530BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20230530BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20230530BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20230530BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20230530BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20230530BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20230530BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20230530BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230530BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20230530BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230530BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20230530BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20230530BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20230530BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230530BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20230530BehaviorOriginIpAcl
    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.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230530BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20230530BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20230530BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20230530BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20230530BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20230530BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230530BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20230530BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20230530BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20230530BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20230530BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20230530BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20230530BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20230530BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20230530BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20230530BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20230530BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20230530BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20230530BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20230530BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20230530BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20230530BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20230530BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20230530BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20230530BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20230530BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20230530BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20230530BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20230530BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20230530BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20230530BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20230530BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20230530BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20230530BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20230530BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20230530BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20230530BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20230530BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20230530BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20230530BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20230530BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20230530BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20230530BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20230530BehaviorWebdav
    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.
    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230530BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20230530BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20230530BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230530BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20230530BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20230530BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20230530BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20230530BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20230530BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20230530BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20230530BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20230530BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20230530BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20230530BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20230530BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20230530BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20230530BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20230530BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20230530BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20230530BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20230530BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20230530BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20230530BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20230530BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230530BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20230530BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20230530BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20230530BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20230530BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20230530BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20230530BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20230530BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20230530BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20230530BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20230530BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20230530BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20230530BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230530BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20230530BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20230530BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20230530BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20230530BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20230530BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20230530BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20230530BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20230530BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20230530BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20230530BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20230530BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20230530BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20230530BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20230530BehaviorEdgeWorker
    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.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230530BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20230530BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20230530BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20230530BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20230530BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20230530BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20230530BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20230530BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20230530BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230530BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230530BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20230530BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20230530BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20230530BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20230530BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20230530BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20230530BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20230530BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20230530BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20230530BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20230530BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230530BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20230530BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230530BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20230530BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20230530BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20230530BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230530BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20230530BehaviorOriginIpAcl
    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.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230530BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20230530BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20230530BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20230530BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20230530BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20230530BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230530BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20230530BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20230530BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20230530BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20230530BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20230530BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20230530BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20230530BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20230530BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20230530BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20230530BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20230530BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20230530BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20230530BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20230530BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20230530BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20230530BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20230530BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20230530BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20230530BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20230530BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20230530BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20230530BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20230530BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20230530BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20230530BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20230530BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20230530BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20230530BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20230530BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20230530BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20230530BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20230530BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20230530BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20230530BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20230530BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20230530BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20230530BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230530BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230530BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20230530BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230530BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20230530BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20230530BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20230530BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20230530BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20230530BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20230530BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20230530BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20230530BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20230530BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20230530BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20230530BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230530BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20230530BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230530BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20230530BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20230530BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20230530BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20230530BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20230530BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20230530BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230530BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20230530BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20230530BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20230530BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20230530BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20230530BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20230530BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20230530BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20230530BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20230530BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20230530BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230530BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230530BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230530BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20230530BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20230530BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20230530BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20230530BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20230530BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20230530BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20230530BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20230530BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20230530BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20230530BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20230530BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20230530BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20230530BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20230530BehaviorEdgeWorker
    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.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230530BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20230530BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20230530BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230530BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20230530BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20230530BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20230530BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20230530BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20230530BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230530BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230530BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20230530BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20230530BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230530BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20230530BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20230530BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20230530BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20230530BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20230530BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20230530BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20230530BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230530BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20230530BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230530BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20230530BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20230530BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20230530BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230530BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20230530BehaviorOriginIpAcl
    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.
    persistentClientConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230530BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20230530BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230530BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20230530BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20230530BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20230530BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230530BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20230530BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20230530BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230530BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20230530BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20230530BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20230530BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230530BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230530BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20230530BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20230530BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20230530BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230530BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20230530BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20230530BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20230530BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20230530BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20230530BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20230530BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20230530BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20230530BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20230530BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20230530BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20230530BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20230530BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20230530BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20230530BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20230530BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20230530BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20230530BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20230530BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20230530BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20230530BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230530BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20230530BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230530BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20230530BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230530BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230530BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230530BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20230530BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230530BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20230530BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20230530BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20230530BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20230530BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20230530BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20230530BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20230530BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20230530BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20230530BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20230530BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20230530BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230530BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20230530BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230530BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20230530BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20230530BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20230530BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20230530BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20230530BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20230530BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230530BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20230530BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20230530BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20230530BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20230530BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20230530BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20230530BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20230530BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20230530BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20230530BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20230530BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230530BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230530BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230530BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20230530BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20230530BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20230530BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230530BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20230530BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20230530BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20230530BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20230530BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20230530BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20230530BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20230530BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20230530BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20230530BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20230530BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20230530BehaviorEdgeWorker
    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.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230530BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20230530BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20230530BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230530BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20230530BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20230530BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20230530BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20230530BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20230530BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230530BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230530BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20230530BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20230530BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230530BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20230530BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20230530BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20230530BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20230530BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20230530BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20230530BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20230530BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20230530BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230530BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20230530BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230530BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20230530BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20230530BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20230530BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20230530BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230530BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20230530BehaviorOriginIpAcl
    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.
    persistentClientConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230530BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20230530BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230530BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20230530BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20230530BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20230530BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230530BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20230530BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20230530BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230530BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20230530BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20230530BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20230530BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230530BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230530BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20230530BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20230530BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20230530BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230530BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20230530BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20230530BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20230530BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20230530BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20230530BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20230530BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20230530BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20230530BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20230530BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20230530BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20230530BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20230530BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20230530BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20230530BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20230530BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20230530BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20230530BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20230530BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20230530BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20230530BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230530BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20230530BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20230530BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230530BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20230530BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230530BehaviorWebdav
    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_circuit_breaker GetPropertyRulesBuilderRulesV20230530BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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 GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptive_image_compression GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230530BehaviorAdvanced
    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 GetPropertyRulesBuilderRulesV20230530BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizer_tag GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizerTag
    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_in_cache_hierarchy GetPropertyRulesBuilderRulesV20230530BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allow_cloudlets_origins GetPropertyRulesBuilderRulesV20230530BehaviorAllowCloudletsOrigins
    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 GetPropertyRulesBuilderRulesV20230530BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_https_cache_key_sharing GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allow_https_downgrade GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsDowngrade
    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 GetPropertyRulesBuilderRulesV20230530BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allow_patch GetPropertyRulesBuilderRulesV20230530BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_post GetPropertyRulesBuilderRulesV20230530BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_put GetPropertyRulesBuilderRulesV20230530BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allow_transfer_encoding GetPropertyRulesBuilderRulesV20230530BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    alt_svc_header GetPropertyRulesBuilderRulesV20230530BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    api_prioritization GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    application_load_balancer GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancer
    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 GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentation
    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_validation GetPropertyRulesBuilderRulesV20230530BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    base_directory GetPropertyRulesBuilderRulesV20230530BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    boss_beaconing GetPropertyRulesBuilderRulesV20230530BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230530BehaviorBreadcrumbs
    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 GetPropertyRulesBuilderRulesV20230530BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230530BehaviorBrotli
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cache_id GetPropertyRulesBuilderRulesV20230530BehaviorCacheId
    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_ignore_case GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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_query_params GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyQueryParams
    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_rewrite GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyRewrite
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCachePost
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCacheRedirect
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCacheTag
    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. The cacheTag 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_visible GetPropertyRulesBuilderRulesV20230530BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230530BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    central_authorization GetPropertyRulesBuilderRulesV20230530BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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 GetPropertyRulesBuilderRulesV20230530BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    client_characteristics GetPropertyRulesBuilderRulesV20230530BehaviorClientCharacteristics
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCloudInterconnects
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloud_wrapper_advanced GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapperAdvanced
    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.
    common_media_client_data GetPropertyRulesBuilderRulesV20230530BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditional_origin GetPropertyRulesBuilderRulesV20230530BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    construct_response GetPropertyRulesBuilderRulesV20230530BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    content_characteristics GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristics
    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_amd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsAmd
    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_dd GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsDd
    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_wsd_large_file GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLargeFile
    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_wsd_live GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLive
    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_wsd_vod GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdVod
    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_position GetPropertyRulesBuilderRulesV20230530BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    content_targeting_protection GetPropertyRulesBuilderRulesV20230530BehaviorContentTargetingProtection
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCorsSupport
    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 GetPropertyRulesBuilderRulesV20230530BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    custom_behavior GetPropertyRulesBuilderRulesV20230530BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230530BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230530BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcp_auth_hmac_transformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_regex_transformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_substring_transformation GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_variable_extractor GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthVariableExtractor
    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_authz_groups GetPropertyRulesBuilderRulesV20230530BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcp_dev_relations GetPropertyRulesBuilderRulesV20230530BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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_time_auth GetPropertyRulesBuilderRulesV20230530BehaviorDcpRealTimeAuth
    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 GetPropertyRulesBuilderRulesV20230530BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    deny_access GetPropertyRulesBuilderRulesV20230530BehaviorDenyAccess
    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_failover_access GetPropertyRulesBuilderRulesV20230530BehaviorDenyDirectFailoverAccess
    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_cache_id GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicCacheId
    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_header GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dns_async_refresh GetPropertyRulesBuilderRulesV20230530BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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 GetPropertyRulesBuilderRulesV20230530BehaviorDnsPrefresh
    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 GetPropertyRulesBuilderRulesV20230530BehaviorDowngradeProtocol
    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_marker GetPropertyRulesBuilderRulesV20230530BehaviorDownloadCompleteMarker
    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 GetPropertyRulesBuilderRulesV20230530BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstream_cache GetPropertyRulesBuilderRulesV20230530BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamic_throughtput_optimization GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimization
    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_optimization_override GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimizationOverride
    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_content GetPropertyRulesBuilderRulesV20230530BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecms_bulk_upload GetPropertyRulesBuilderRulesV20230530BehaviorEcmsBulkUpload
    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 GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecms_dataset GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDataset
    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_key GetPropertyRulesBuilderRulesV20230530BehaviorEcmsObjectKey
    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 GetPropertyRulesBuilderRulesV20230530BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edge_load_balancing_advanced GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingAdvanced
    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_balancing_data_center GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenter
    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_balancing_origin GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingOrigin
    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.
    edge_origin_authorization GetPropertyRulesBuilderRulesV20230530BehaviorEdgeOriginAuthorization
    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 GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edge_scape GetPropertyRulesBuilderRulesV20230530BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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_includes GetPropertyRulesBuilderRulesV20230530BehaviorEdgeSideIncludes
    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, or filename. 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 GetPropertyRulesBuilderRulesV20230530BehaviorEdgeWorker
    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_protocol GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedAkamaiProtocol
    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_detection GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedProxyDetection
    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_header_enrichment GetPropertyRulesBuilderRulesV20230530BehaviorEpdForwardHeaderEnrichment
    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 GetPropertyRulesBuilderRulesV20230530BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failover_bot_manager_feature_compatibility GetPropertyRulesBuilderRulesV20230530BehaviorFailoverBotManagerFeatureCompatibility
    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 GetPropertyRulesBuilderRulesV20230530BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    first_party_marketing GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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_marketing_plus GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing 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 GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230530BehaviorG2oheader
    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_number GetPropertyRulesBuilderRulesV20230530BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphql_caching GetPropertyRulesBuilderRulesV20230530BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzip_response GetPropertyRulesBuilderRulesV20230530BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hd_data_advanced GetPropertyRulesBuilderRulesV20230530BehaviorHdDataAdvanced
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHealthDetection
    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_binding GetPropertyRulesBuilderRulesV20230530BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230530BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    http_strict_transport_security GetPropertyRulesBuilderRulesV20230530BehaviorHttpStrictTransportSecurity
    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_https_upgrade GetPropertyRulesBuilderRulesV20230530BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    im_override GetPropertyRulesBuilderRulesV20230530BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    image_and_video_manager GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManager
    This behavior can be used in includes.
    image_manager GetPropertyRulesBuilderRulesV20230530BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    image_manager_video GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230530BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20230530BehaviorInstant
    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 GetPropertyRulesBuilderRulesV20230530BehaviorInstantConfig
    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_optimization GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    large_file_optimization_advanced GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limit_bit_rate GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    log_custom GetPropertyRulesBuilderRulesV20230530BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    m_pulse GetPropertyRulesBuilderRulesV20230530BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifest_personalization GetPropertyRulesBuilderRulesV20230530BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifest_rerouting GetPropertyRulesBuilderRulesV20230530BehaviorManifestRerouting
    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_push GetPropertyRulesBuilderRulesV20230530BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    media_acceleration GetPropertyRulesBuilderRulesV20230530BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    media_acceleration_quic_optout GetPropertyRulesBuilderRulesV20230530BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    media_client GetPropertyRulesBuilderRulesV20230530BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    media_file_retrieval_optimization GetPropertyRulesBuilderRulesV20230530BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    media_origin_failover GetPropertyRulesBuilderRulesV20230530BehaviorMediaOriginFailover
    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 GetPropertyRulesBuilderRulesV20230530BehaviorMetadataCaching
    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_performance GetPropertyRulesBuilderRulesV20230530BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modify_incoming_request_header GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modify_incoming_response_header GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modify_outgoing_request_header GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modify_outgoing_response_header GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modify_via_header GetPropertyRulesBuilderRulesV20230530BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230530BehaviorOrigin
    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 GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristics
    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_wsd GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    origin_failure_recovery_method GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    origin_failure_recovery_policy GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    origin_ip_acl GetPropertyRulesBuilderRulesV20230530BehaviorOriginIpAcl
    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_connection GetPropertyRulesBuilderRulesV20230530BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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 GetPropertyRulesBuilderRulesV20230530BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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_information GetPropertyRulesBuilderRulesV20230530BehaviorPersonallyIdentifiableInformation
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230530BehaviorPreconnect
    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_delivery GetPropertyRulesBuilderRulesV20230530BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictive_prefetching GetPropertyRulesBuilderRulesV20230530BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230530BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefresh_cache GetPropertyRulesBuilderRulesV20230530BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230530BehaviorQuality
    This behavior can be used in includes.
    quic_beta GetPropertyRulesBuilderRulesV20230530BehaviorQuicBeta
    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 GetPropertyRulesBuilderRulesV20230530BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230530BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    read_timeout GetPropertyRulesBuilderRulesV20230530BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    real_time_reporting GetPropertyRulesBuilderRulesV20230530BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    real_user_monitoring GetPropertyRulesBuilderRulesV20230530BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230530BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230530BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    referer_checking GetPropertyRulesBuilderRulesV20230530BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    remove_query_parameter GetPropertyRulesBuilderRulesV20230530BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    remove_vary GetPropertyRulesBuilderRulesV20230530BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230530BehaviorReport
    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 GetPropertyRulesBuilderRulesV20230530BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    request_type_marker GetPropertyRulesBuilderRulesV20230530BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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 GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resource_optimizer_extended_compatibility GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizerExtendedCompatibility
    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 GetPropertyRulesBuilderRulesV20230530BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    response_cookie GetPropertyRulesBuilderRulesV20230530BehaviorResponseCookie
    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_caching GetPropertyRulesBuilderRulesV20230530BehaviorRestrictObjectCaching
    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_status GetPropertyRulesBuilderRulesV20230530BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewrite_url GetPropertyRulesBuilderRulesV20230530BehaviorRewriteUrl
    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 GetPropertyRulesBuilderRulesV20230530BehaviorRumCustom
    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 GetPropertyRulesBuilderRulesV20230530BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    sales_force_commerce_cloud_client GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudClient
    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_commerce_cloud_provider GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    sales_force_commerce_cloud_provider_host_header GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    save_post_dca_processing GetPropertyRulesBuilderRulesV20230530BehaviorSavePostDcaProcessing
    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 GetPropertyRulesBuilderRulesV20230530BehaviorScheduleInvalidation
    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 GetPropertyRulesBuilderRulesV20230530BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmented_content_protection GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmented_media_optimization GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmented_media_streaming_prefetch GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaStreamingPrefetch
    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 GetPropertyRulesBuilderRulesV20230530BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulate_error_code GetPropertyRulesBuilderRulesV20230530BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    site_shield GetPropertyRulesBuilderRulesV20230530BehaviorSiteShield
    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_migration GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standard_tls_migration_override GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigrationOverride
    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_parsing GetPropertyRulesBuilderRulesV20230530BehaviorStrictHeaderParsing
    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 GetPropertyRulesBuilderRulesV20230530BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sure_route GetPropertyRulesBuilderRulesV20230530BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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 GetPropertyRulesBuilderRulesV20230530BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    tea_leaf GetPropertyRulesBuilderRulesV20230530BehaviorTeaLeaf
    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 GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistribution
    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 the cache 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_advanced GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tiered_distribution_customization GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230530BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uid_configuration GetPropertyRulesBuilderRulesV20230530BehaviorUidConfiguration
    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_tag GetPropertyRulesBuilderRulesV20230530BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verify_json_web_token GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verify_json_web_token_for_dcp GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verify_token_authorization GetPropertyRulesBuilderRulesV20230530BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtual_waiting_room GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtual_waiting_room_with_edge_workers GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoomWithEdgeWorkers
    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 GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo_standalone GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230530BehaviorWatermarking
    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_firewall GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewall
    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 GetPropertyRulesBuilderRulesV20230530BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230530BehaviorWebdav
    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.
    adScalerCircuitBreaker Property Map
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration 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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression Property Map
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. 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.
    aggregatedReporting Property Map
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. 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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag 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.
    allHttpInCacheHierarchy Property Map
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins Property Map
    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.
    allowDelete 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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing Property Map
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade Property Map
    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.
    allowOptions 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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch 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, and allowPut behaviors. This behavior can be used in includes.
    allowPost 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, and allowPut behaviors. This behavior can be used in includes.
    allowPut 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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding Property Map
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader Property Map
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization 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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer Property Map
    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.
    audienceSegmentation 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.
    autoDomainValidation Property Map
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory Property Map
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing 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.
    breadcrumbs 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.
    breakConnection 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.
    cacheError 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, and 505. This behavior can be used in includes.
    cacheId 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.
    cacheKeyIgnoreCase Property Map
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams Property Map
    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.
    cacheKeyRewrite Property Map
    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.
    cachePost 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.
    cacheRedirect 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.
    cacheTag 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. The cacheTag 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.
    cacheTagVisible Property Map
    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 the modifyOutgoingResponseHeader 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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization 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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects Property Map
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCharacteristics 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.
    cloudInterconnects 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.
    cloudWrapper 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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced Property Map
    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.
    commonMediaClientData Property Map
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin Property Map
    This behavior cannot be used in includes.
    constructResponse 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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics 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.
    contentCharacteristicsAmd 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.
    contentCharacteristicsDd 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.
    contentCharacteristicsWsdLargeFile Property Map
    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.
    contentCharacteristicsWsdLive Property Map
    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.
    contentCharacteristicsWsdVod Property Map
    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.
    contentPrePosition Property Map
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection Property Map
    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.
    corsSupport 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.
    cpCode 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 the List CP codes operation. This behavior can be used in includes.
    customBehavior 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 relevant behaviorId value from the response within the current customBehavior. See Custom 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 the DataStream 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. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor Property Map
    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.
    dcpDefaultAuthzGroups Property Map
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations Property Map
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth Property Map
    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.
    deliveryReceipt 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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess 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.
    denyDirectFailoverAccess Property Map
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId Property Map
    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.
    deviceCharacteristicHeader Property Map
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh Property Map
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh 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.
    downgradeProtocol 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.
    downloadCompleteMarker 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 logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes.
    downloadNotification 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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache 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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization Property Map
    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.
    dynamicThroughtputOptimizationOverride Property Map
    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.
    dynamicWebContent Property Map
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload Property Map
    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.
    ecmsDatabase 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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset 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.
    ecmsObjectKey Property Map
    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.
    edgeConnect Property Map
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced Property Map
    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.
    edgeLoadBalancingDataCenter Property Map
    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.
    edgeLoadBalancingOrigin Property Map
    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.
    edgeOriginAuthorization 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.
    edgeRedirector Property Map
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape 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 special X-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.
    edgeSideIncludes Property Map
    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, or filename. 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.
    edgeWorker 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.
    enhancedAkamaiProtocol Property Map
    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.
    enhancedProxyDetection Property Map
    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.
    epdForwardHeaderEnrichment Property Map
    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.
    failAction 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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility Property Map
    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.
    fastInvalidate Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    firstPartyMarketing Property Map
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus Property Map
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite 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 within Control Center, or use the Cloudlets API to configure it programmatically. 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.
    globalRequestNumber Property Map
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching Property Map
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse 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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced Property Map
    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.
    healthDetection 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.
    hsafEipBinding Property Map
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity Property Map
    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.
    httpToHttpsUpgrade Property Map
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride 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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager Property Map
    This behavior can be used in includes.
    imageManager 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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo Property Map
    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 a fileExtension. 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.
    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.
    instantConfig 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.
    largeFileOptimization Property Map
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced Property Map
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate Property Map
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom Property Map
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse Property Map
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization 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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting 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.
    manualServerPush Property Map
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration Property Map
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout Property Map
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization Property Map
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover Property Map
    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.
    metadataCaching 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.
    mobileSdkPerformance Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader Property Map
    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.
    originCharacteristics 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.
    originCharacteristicsWsd Property Map
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod Property Map
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy Property Map
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl Property Map
    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.
    persistentClientConnection Property Map
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection Property Map
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation Property Map
    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.
    phasedRelease 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 within Control 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.
    predictiveContentDelivery Property Map
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching 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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache 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.
    quicBeta 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.
    randomSeek 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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout 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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting Property Map
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring Property Map
    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 on destinationHostname and destinationPath 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 use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking Property Map
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter Property Map
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary Property Map
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary 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.
    requestControl 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker Property Map
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility Property Map
    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.
    responseCode 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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie 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.
    restrictObjectCaching Property Map
    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.
    returnCacheStatus Property Map
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl 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.
    rumCustom 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.
    saasDefinitions Property Map
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient Property Map
    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.
    salesForceCommerceCloudProvider Property Map
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader Property Map
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing Property Map
    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.
    scheduleInvalidation 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.
    scriptManagement Property Map
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection Property Map
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization Property Map
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch Property Map
    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.
    setVariable 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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode Property Map
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield 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.
    standardTlsMigration Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride 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.
    strictHeaderParsing Property Map
    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.
    subCustomer 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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute Property Map
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf 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.
    tieredDistribution 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 the cache 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.
    tieredDistributionAdvanced 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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization Property Map
    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 enable cloudWrapper 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.
    uidConfiguration 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.
    validateEntityTag Property Map
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken Property Map
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp Property Map
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization Property Map
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom Property Map
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers Property Map
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization Property Map
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo Property Map
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone Property Map
    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.
    webApplicationFirewall Property Map
    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.
    webSockets 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorAdScalerCircuitBreaker

    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased string
    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.
    responseCodeBased boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased string
    Defines a custom error response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response_code_based str
    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_based bool
    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, or SPECIFY_YOUR_OWN for a custom code.
    response_delay_based bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    response_delay_threshold str
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    return_error_response_code_based str
    Specifies the error to include in the response to the client.
    specify_your_own_response_code_based str
    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.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveAcceleration

    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid string
    This option is for internal usage only.
    titleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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. See Add 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.
    cookie_name str
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enable_brotli_compression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enable_for_noncacheable bool
    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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring 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_server_push str
    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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorAdaptiveImageCompression

    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Integer
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Integer
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Integer
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Integer
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Integer
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Integer
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    compressMobile boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid string
    This option is for internal usage only.
    tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    tier1MobileCompressionValue number
    Specifies the compression percentage.
    tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue number
    Specifies the compression percentage.
    tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue number
    Specifies the compression percentage.
    tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue number
    Specifies the compression percentage.
    tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue number
    Specifies the compression percentage.
    tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue number
    Specifies the compression percentage.
    titleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    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_compression_method str
    Specifies tier-1 behavior.
    tier1_mobile_compression_value int
    Specifies the compression percentage.
    tier1_standard_compression_method str
    Specifies tier-1 non-cellular network behavior.
    tier1_standard_compression_value int
    Specifies the compression percentage.
    tier2_mobile_compression_method str
    Specifies tier-2 cellular-network behavior.
    tier2_mobile_compression_value int
    Specifies the compression percentage.
    tier2_standard_compression_method str
    Specifies tier-2 non-cellular network behavior.
    tier2_standard_compression_value int
    Specifies the compression percentage.
    tier3_mobile_compression_method str
    Specifies tier-3 cellular-network behavior.
    tier3_mobile_compression_value int
    Specifies the compression percentage.
    tier3_standard_compression_method str
    Specifies tier-3 non-cellular network behavior.
    tier3_standard_compression_value int
    Specifies the compression percentage.
    title_aic_mobile str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    title_aic_nonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Number
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Number
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Number
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Number
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Number
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Number
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorAggregatedReporting

    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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizer

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAkamaizerTag

    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname string
    Specifies the replacement hostname for the tag to use.
    scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    include_tags_attribute 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.
    tags_attribute 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.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllHttpInCacheHierarchy

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowCloudletsOrigins

    Enabled bool
    Allows you to assign custom origin definitions referenced in sub-rules by cloudletsOrigin labels. If disabled, all sub-rules are ignored.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory boolean
    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.
    purgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_directory bool
    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_query_parameter str
    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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowDelete

    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsCacheKeySharing

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowHttpsDowngrade

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowOptions

    Enabled bool
    Set this to true to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowPatch

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowPost

    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled boolean
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_content_length bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled 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.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowPut

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAllowTransferEncoding

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAltSvcHeader

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge Integer
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the Alt-Svc header. The default max-age for an Alt-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.
    maxAge Number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritization

    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    alternateResponseCacheTtl Integer
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Integer
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.
    alternateResponseCacheTtl number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid string
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode boolean
    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_cache_ttl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled bool
    Activates the API Prioritization feature.
    is_shared_policy 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.
    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 GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    net_storage_path str
    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_code GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttled_status_code int
    Specifies the HTTP response code for requests that receive the alternate response.
    use_throttled_cp_code bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    use_throttled_status_code bool
    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.
    alternateResponseCacheTtl Number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage Property Map
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode Property Map
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.

    GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancer

    AllDownNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps List<GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes List<string>
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllDownNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps []GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerFailoverOriginMap
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes []string
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Integer
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode string
    Determines what to do if an origin fails.
    failoverOriginMaps GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerFailoverOriginMap[]
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes string[]
    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.
    failoverTitle 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.
    originCookieName string
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration string
    Sets how long it is before the cookie expires.
    stickinessExpirationDate string
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_net_storage GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    all_down_net_storage_file str
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    all_down_status_code str
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    all_down_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_cache_prefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cached_content_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Activates the Application Load Balancer Cloudlet.
    failover_attempts_threshold int
    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_maps Sequence[GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerFailoverOriginMap]
    Specifies a fixed set of failover mapping rules.
    failover_status_codes Sequence[str]
    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.
    origin_cookie_name str
    Specifies the name for your session cookie.
    specify_stickiness_cookie_domain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickiness_cookie_automatic_salt 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.
    stickiness_cookie_domain str
    Specifies the domain to track the stickiness cookie.
    stickiness_cookie_salt str
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickiness_cookie_set_http_only_flag bool
    Ensures the cookie is transmitted only over HTTP.
    stickiness_cookie_type 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_date str
    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.
    allDownNetStorage Property Map
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<Property Map>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerAllDownNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorApplicationLoadBalancerFailoverOriginMap

    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds List<string>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds []string
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds string[]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    from_origin_id str
    Specifies the origin whose failure triggers the mapping rule.
    to_origin_ids Sequence[str]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.

    GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentation

    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain string
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType string
    Specifies when the segmentation cookie expires.
    populationDuration string
    Specifies the lifetime of the segmentation cookie.
    populationRefresh boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    population_cookie_automatic_salt 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.
    population_cookie_domain str
    Specifies the domain to track the population cookie.
    population_cookie_include_rule_name bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    population_cookie_salt str
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    population_cookie_type 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.
    segment_tracking_cookie_name str
    This cookie name specifies the name of the segmentation rule.
    segment_tracking_custom_header str
    This custom HTTP header specifies the name of the segmentation rule.
    segment_tracking_method str
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segment_tracking_query_param str
    This query parameter specifies the name of the segmentation rule.
    segment_tracking_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specify_population_cookie_domain 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorAudienceSegmentationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorAutoDomainValidation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorBaseDirectory

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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/.

    GetPropertyRulesBuilderRulesV20230530BehaviorBossBeaconing

    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses List<string>
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses []string
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern string
    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.
    conditionalHttpStatuses string[]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency string
    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.
    forwardType 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.
    requestType string
    Specify when to trigger a beacon.
    samplingFrequency string
    Specifies a sampling frequency or disables beacons.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_pattern str
    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_statuses Sequence[str]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditional_sampling_frequency str
    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.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorBreadcrumbs

    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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 opposite ak-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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorBreakConnection

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorBrotli

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheError

    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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and 504 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 to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheId

    Elements List<string>
    Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    Specifies the name of the variable you want to include in the cache key.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyIgnoreCase

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyQueryParams

    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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheKeyRewrite

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey string
    Specifies the new cache key path as an alphanumeric value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCachePost

    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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    templateUuid string
    This option is for internal usage only.
    useBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheRedirect

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheTag

    Locked bool
    Indicates 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCacheTagVisible

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCaching

    Behavior string
    Specify the caching option.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    cacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl string
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache boolean
    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 live ttl to zero seconds.
    honorNoStore boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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_directives str
    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_support bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-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_age bool
    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 the max-age directive and the defaultTtl setting.
    honor_must_revalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honor_no_cache bool
    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 live ttl to zero seconds.
    honor_no_store bool
    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_revalidate bool
    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_maxage 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 the max-age directive and the defaultTtl 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.

    GetPropertyRulesBuilderRulesV20230530BehaviorCentralAuthorization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorChaseRedirects

    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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorClientCharacteristics

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCloudInterconnects

    CloudLocations 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudLocations []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapper

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCloudWrapperAdvanced

    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_map str
    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.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCommonMediaClientData

    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_cmcd_segment_prefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked bool
    Indicates that your 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.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorConditionalOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorConstructResponse

    Body string
    HTML response of up to 2000 characters to send to the end-user client.
    Enabled bool
    Serves the custom response.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Integer
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode number
    The HTTP response code to send to the end-user client.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Number
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristics

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsAmd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom double
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom double
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom float64
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom float64
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Integer
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Integer
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Double
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Double
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationDashCustom number
    Customizes the number of seconds for the segment.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom number
    Customizes the number of seconds for the fragment.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationHlsCustom number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom number
    Customizes the number of seconds for the fragment.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_dash_custom int
    Customizes the number of seconds for the segment.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hds_custom int
    Customizes the number of seconds for the fragment.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_hls_custom float
    Customizes the number of seconds for the segment.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_duration_smooth_custom float
    Customizes the number of seconds for the fragment.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Number
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Number
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsDd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLargeFile

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdLive

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentCharacteristicsWsdVod

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentPrePosition

    Enabled bool
    Enables the Content PrePosition behavior.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation string
    sourceType string
    targets string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorContentTargetingProtection

    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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains List<string>
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses []string
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses []string
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains []string
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled boolean
    Enables the Content Targeting feature.
    geoProtectionMode string
    Specifies how to handle requests.
    geoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses string[]
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode string
    Specifies how to handle requests.
    ipProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl string
    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.
    overrideIpAddresses string[]
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains string[]
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode string
    Specify the action to take.
    referrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_protection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enable_geo_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_ip_protection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enable_ip_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_referrer_protection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enable_referrer_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enabled bool
    Enables the Content Targeting feature.
    geo_protection_mode str
    Specifies how to handle requests.
    geo_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geo_redirect_url str
    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_mode str
    Specifies how to handle requests.
    ip_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ip_redirect_url str
    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_addresses Sequence[str]
    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_mode str
    Specify the action to take.
    referrer_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrer_redirect_url str
    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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCorsSupport

    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders []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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflight_max_age str
    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.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorCustomBehavior

    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDatastream

    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames List<string>
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames []string
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Integer
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled boolean
    Enables 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.
    logEnabled boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames string[]
    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.
    logStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage number
    Specifies the percentage of log data you want to collect for this property.
    streamType string
    Specify the DataStream type.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collect_midgress_traffic bool
    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_names Sequence[str]
    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_title str
    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.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Number
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcp

    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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.
    namespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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 the IoT 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthHmacTransformation

    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm string
    Specifies the hash algorithm.
    hashConversionKey string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_algorithm str
    Specifies the hash algorithm.
    hash_conversion_key str
    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.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthRegexTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthSubstringTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpAuthVariableExtractor

    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField string
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_auth_processing_variable_id str
    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.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpDefaultAuthzGroups

    GroupNames 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    GroupNames []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpDevRelations

    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDcpRealTimeAuth

    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname boolean
    Extracts a hostname from JWT.
    extractJurisdiction boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDeliveryReceipt

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDenyAccess

    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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDenyDirectFailoverAccess

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicCacheId

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDeviceCharacteristicHeader

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDnsAsyncRefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorDnsPrefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorDowngradeProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDownloadCompleteMarker

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDownloadNotification

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDownstreamCache

    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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 a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.

    GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorDynamicThroughtputOptimizationOverride

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorDynamicWebContent

    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_monitoring bool
    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.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEcmsBulkUpload

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDatabase

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern string
    Specifies the regular expression that matches the database name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEcmsDataset

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEcmsObjectKey

    Locked bool
    Indicates 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeConnect

    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements List<string>
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements []string
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines string
    Specifies the maximum number of lines to include in each log.
    aggregateSize string
    Specifies the log's maximum size.
    aggregateTime string
    Specifies how often logs are generated.
    apiConnector string
    Describes the API connector type.
    apiDataElements string[]
    Specifies the data set to log.
    destinationHostname string
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings boolean
    When enabled, overrides default log settings.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_elements Sequence[str]
    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_settings bool
    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.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenter

    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules List<GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules []GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenterFailoverRule
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description string
    Provides a description for the ELB data center, for your own reference.
    enableFailover boolean
    Allows you to specify failover rules.
    failoverRules GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenterFailoverRule[]
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_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[GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenterFailoverRule]
    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 the edgeLoadBalancingOrigin 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.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<Property Map>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingDataCenterFailoverRule

    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname string
    The hostname of the data center to fail over to.
    modifyRequest boolean
    Allows you to modify the request's hostname or path.
    overrideHostname 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.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeLoadBalancingOrigin

    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description string
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description str
    Provides a description for the ELB origin, for your own reference.
    enable_session_persistence bool
    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 the edgeLoadBalancingDataCenter 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_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.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeOriginAuthorization

    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookie_name 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirector

    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy 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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeRedirectorCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeScape

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeSideIncludes

    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets List<string>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets []string
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection boolean
    Denies attempts to inject ESI code.
    enableViaHttp boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled boolean
    Enables ESI processing.
    i18nCharsets string[]
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_http bool
    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 and ISO-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_ip bool
    Allows edge servers to pass the client IP header to the ESI processor.
    pass_set_cookie 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.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEdgeWorker

    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId string
    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.
    resourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_worker str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edge_worker_id str
    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.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedAkamaiProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorEnhancedProxyDetection

    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction string
    Specifies how to field the proxy request.
    bestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction string
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy boolean
    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.
    detectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode string
    Specifies how to field the proxy request.
    enabled boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment boolean
    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.
    hostingProvider 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.
    publicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter string
    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_action str
    Specifies how to field the proxy request.
    best_practice_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_anonymous_vpn bool
    This enables detection of requests from anonymous VPNs.
    detect_anonymous_vpn_action str
    Specifies how to field anonymous VPN requests.
    detect_anonymous_vpn_redirecturl str
    This specifies the URL to which to redirect anonymous VPN requests.
    detect_hosting_provider bool
    This detects requests from a hosting provider.
    detect_hosting_provider_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detect_hosting_provider_redirecturl str
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detect_public_proxy bool
    This enables detection of requests from public proxies.
    detect_public_proxy_action str
    Specifies how to field public proxy requests.
    detect_public_proxy_redirecturl str
    This specifies the URL to which to redirect public proxy requests.
    detect_residential_proxy bool
    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_proxy_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detect_residential_proxy_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_smart_dns_proxy bool
    This enables detection of requests from smart DNS proxies.
    detect_smart_dns_proxy_action str
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detect_smart_dns_proxy_redirecturl str
    This specifies the URL to which to redirect DNS proxy requests.
    detect_tor_exit_node bool
    This enables detection of requests from Tor exit nodes.
    detect_tor_exit_node_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detect_tor_exit_node_redirecturl str
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detect_vpn_data_center bool
    This enables detection of requests from VPN data centers.
    detect_vpn_data_center_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detect_vpn_data_center_redirecturl str
    This specifies the URL to which to redirect requests from VPN data centers.
    enable_configuration_mode str
    Specifies how to field the proxy request.
    enabled bool
    Applies GeoGuard proxy detection.
    forward_header_enrichment bool
    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_proxy 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.
    tor_exit_node 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.
    vpn_data_center str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorEpdForwardHeaderEnrichment

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorFailAction

    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20230530BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20230530BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20230530BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Integer
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Integer
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Integer
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride boolean
    cexCustomPath boolean
    Specifies a custom path.
    cexHostname string
    Specifies a hostname.
    cexPath string
    Specifies a custom path.
    contentCustomPath boolean
    Specifies a custom redirect path.
    contentHostname string
    Specifies the static hostname for the alternate redirect.
    contentPath string
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath boolean
    Allows you to modify the original requested path.
    dynamicMethod string
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20230530BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath boolean
    Uses the redirectPath to customize a new path.
    redirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType string
    Whether to preserve or customize the hostname.
    redirectMethod number
    Specifies the HTTP response code.
    redirectPath string
    Specifies a new path.
    saasCnameEnabled boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    saasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode number
    Assigns a new HTTP status code to the failure response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_parent_override bool
    cex_custom_path bool
    Specifies a custom path.
    cex_hostname str
    Specifies a hostname.
    cex_path str
    Specifies a custom path.
    content_custom_path bool
    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 GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamic_custom_path bool
    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_hostname GetPropertyRulesBuilderRulesV20230530BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    net_storage_path str
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserve_query_string bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol str
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirect_custom_path bool
    Uses the redirectPath to customize a new path.
    redirect_hostname str
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirect_hostname_type str
    Whether to preserve or customize the hostname.
    redirect_method int
    Specifies the HTTP response code.
    redirect_path str
    Specifies a new path.
    saas_cname_enabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saas_cname_level int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saas_query_string str
    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.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode Property Map
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname Property Map
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Number
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Number
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorFailActionCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorFailActionNetStorageHostname

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230530BehaviorFailoverBotManagerFeatureCompatibility

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorFastInvalidate

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketing

    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlus

    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorFirstPartyMarketingPlusCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewrite

    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorForwardRewriteCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorG2oheader

    CustomSignStrings List<string>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    CustomSignStrings []string
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Integer
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customSignStrings string[]
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled boolean
    Enables the g2o verification behavior.
    encodingVersion number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked boolean
    Indicates 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.
    secretKey string
    Specifies the shared secret key.
    signedHeader string
    Specifies the name of the header containing encrypted request data.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_strings Sequence[str]
    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 through 5.
    locked bool
    Indicates 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_sign_string bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorGlobalRequestNumber

    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption string
    Specifies how to report the GRN value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorGraphqlCaching

    Advanced string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors boolean
    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.
    operationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_with_errors bool
    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_body_parameter_name str
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operations_url_query_parameter_name str
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    post_request_processing_error_handling str
    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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorGzipResponse

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorHdDataAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorHealthDetection

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects 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 of retryCount.
    retryCount Integer
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 of retryCount.
    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.
    maximumReconnects Number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount Number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorHsafEipBinding

    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Integer
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Integer
    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.
    templateUuid 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.
    customExtractedSerial boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue number
    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.
    templateUuid 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_serial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hash_max_value int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hash_min_value int
    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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Number
    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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorHttp2

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorHttp3

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorHttpStrictTransportSecurity

    Enable bool
    Applies HSTS to this set of requests.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Integer
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains boolean
    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.
    maxAge 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.
    redirectStatusCode number
    Specifies a response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_domains bool
    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_code int
    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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Number
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorHttpToHttpsUpgrade

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImOverride

    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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters List<string>
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters []string
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.
    excludeAllQueryParameters boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters string[]
    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.
    policyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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_query_parameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excluded_query_parameters Sequence[str]
    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_mvar str
    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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManager

    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    applyBestFileType Boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformed
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String
    applyBestFileType boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformed
    enabled boolean
    imageSet 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.
    policySetType string
    resize boolean
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet string
    apply_best_file_type bool
    cp_code_original GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginal
    cp_code_transformed GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformed
    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_type str
    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
    applyBestFileType Boolean
    cpCodeOriginal Property Map
    cpCodeTransformed Property Map
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String

    GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManager

    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    api_reference_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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_default str
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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_region str
    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_policy_set bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal Property Map
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideo

    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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_default str
    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_region str
    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_policy_set bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal Property Map
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorInclude

    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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorInstant

    CustomLinkRelations List<string>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions List<string>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLinkRelations []string
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions []string
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations string[]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions string[]
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_relations Sequence[str]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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 the tieredDistribution 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_store bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetch_no_store_extensions Sequence[str]
    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.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorInstantConfig

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimization

    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching string
    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.
    maximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid string
    This option is for internal usage only.
    useVersioning boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_object_caching str
    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 or GB. 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 or GB.
    template_uuid str
    This option is for internal usage only.
    use_versioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    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.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorLargeFileOptimizationAdvanced

    Enabled bool
    Enables the file optimization behavior.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Integer
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Integer
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest number
    The number of POC fragments to prefetch during the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or GB suffix.
    prefetch_after_request int
    The number of POC fragments to prefetch after the request.
    prefetch_during_request int
    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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Number
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRate

    BitrateTables List<GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables List<GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BitrateTables []GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateBitrateTable
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables []GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateThresholdTable
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables List<GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables List<GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateBitrateTable[]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid string
    This option is for internal usage only.
    thresholdTables GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateThresholdTable[]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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[GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateBitrateTable]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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[GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateThresholdTable]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    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.
    bitrateTables 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 numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables 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 numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateBitrateTable

    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue double
    The numeric indicator of the download rate.
    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue float64
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Double
    The numeric indicator of the download rate.
    bitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue number
    The numeric indicator of the download rate.
    bitrate_unit str
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrate_value float
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Number
    The numeric indicator of the download rate.

    GetPropertyRulesBuilderRulesV20230530BehaviorLimitBitRateThresholdTable

    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Integer
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue 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, or BYTES of the file size.
    threshold_value int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Number
    The numeric indicator of the minimum file size or elapsed download time.

    GetPropertyRulesBuilderRulesV20230530BehaviorLogCustom

    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_field str
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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_log_field bool
    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.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMPulse

    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    apiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid string
    This option is for internal usage only.
    titleOptional 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}}". See Configuration 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorManifestPersonalization

    Enabled bool
    Enables the Manifest Personalization feature.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges string
    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.
    hlsFilterInBitrates string
    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.
    hlsMode string
    Applies with hlsEnabled on.
    hlsPreferredBitrate string
    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.
    hlsQueryParamEnabled boolean
    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.
    hlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_debug_headers bool
    Includes additional Akamai-Manifest-Personalization and Akamai-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_in_bitrate_ranges str
    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_in_bitrates str
    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_bitrate str
    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_param_enabled bool
    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_param_secret_key str
    Specifies a primary key as a token to accompany the request.
    hls_query_param_transition_key str
    Specifies a transition key as a token to accompany the request.
    hls_show_advanced bool
    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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorManifestRerouting

    Locked bool
    Indicates 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorManualServerPush

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMediaAcceleration

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMediaAccelerationQuicOptout

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMediaClient

    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    beaconId 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.
    templateUuid string
    This option is for internal usage only.
    useHybridHttpUdp boolean
    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_http_udp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.

    GetPropertyRulesBuilderRulesV20230530BehaviorMediaFileRetrievalOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMediaOriginFailover

    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes []string
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes []string
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Integer
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Integer
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Integer
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse boolean
    When enabled, caches the error response.
    cacheWindow string
    This sets error response's TTL.
    clientResponseCode string
    Specifies the response code served to the client.
    detectObjectUnavailable boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost string
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery string
    This sets the recovery option.
    objectUnavailableRedirectMethod number
    Specifies a redirect response code.
    objectUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit string
    Sets how many times to retry.
    originUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost string
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath string
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath boolean
    Modifies the request path.
    originUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery string
    This sets the recovery option.
    originUnavailableRedirectMethod number
    Specifies either a redirect response code.
    originUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit string
    Sets how many times to retry.
    originUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost string
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath boolean
    Modifies the request path.
    originUnresponsiveProtocol string
    Specifies which protocol to use.
    originUnresponsiveRecovery string
    This sets the recovery option.
    originUnresponsiveRedirectMethod number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit string
    Sets how many times to retry.
    otherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response bool
    When enabled, caches the error response.
    cache_window str
    This sets error response's TTL.
    client_response_code str
    Specifies the response code served to the client.
    detect_object_unavailable bool
    Allows you to configure failover settings when the origin has content errors.
    detect_object_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    detect_origin_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    detect_origin_unresponsive_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.
    object_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    object_unavailable_backup_host str
    This specifies the origin hostname.
    object_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    object_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    object_unavailable_change_protocol bool
    Changes the request protocol.
    object_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    object_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    object_unavailable_modified_path str
    This specifies the path to form the new URL.
    object_unavailable_modify_request_path bool
    Enabling this allows you to modify the request path.
    object_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    object_unavailable_recovery str
    This sets the recovery option.
    object_unavailable_redirect_method int
    Specifies a redirect response code.
    object_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when there are content errors.
    object_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unavailable_backup_host str
    This specifies the origin hostname.
    origin_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unavailable_change_protocol bool
    Modifies the request protocol.
    origin_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    origin_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unavailable_modified_path str
    This specifies the path to form the new URL.
    origin_unavailable_modify_request_path bool
    Modifies the request path.
    origin_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    origin_unavailable_recovery str
    This sets the recovery option.
    origin_unavailable_redirect_method int
    Specifies either a redirect response code.
    origin_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when the origin responds with errors.
    origin_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unresponsive_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unresponsive_backup_host str
    This specifies the origin hostname.
    origin_unresponsive_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unresponsive_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unresponsive_change_protocol bool
    This allows you to change the request protocol.
    origin_unresponsive_detection_level str
    Specify the level of response to slow origin connections.
    origin_unresponsive_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unresponsive_modified_path str
    This specifies the path to form the new URL.
    origin_unresponsive_modify_request_path bool
    Modifies the request path.
    origin_unresponsive_protocol str
    Specifies which protocol to use.
    origin_unresponsive_recovery str
    This sets the recovery option.
    origin_unresponsive_redirect_method int
    Specifies the redirect response code.
    origin_unresponsive_retry_limit str
    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.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Number
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Number
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMetadataCaching

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorMobileSdkPerformance

    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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to_origin bool
    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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingRequestHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Supplies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Supplies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorModifyIncomingResponseHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Specifies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingRequestHeader

    Action string
    Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies an HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorModifyOutgoingResponseHeader

    Action string
    Either ADD or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies the new HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies the new HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorModifyViaHeader

    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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption string
    Specify how you want to handle the header.
    renameHeaderTo string
    Specifies a new name to replace the existing Via header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to str
    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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorOrigin

    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities List<GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthority>
    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.
    CustomCertificates List<GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificate>
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues List<string>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    NetStorage GetPropertyRulesBuilderRulesV20230530BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities List<string>
    TemplateUuid string
    This option is for internal usage only.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities []GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthority
    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.
    CustomCertificates []GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificate
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues []string
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    NetStorage GetPropertyRulesBuilderRulesV20230530BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities []string
    TemplateUuid string
    This option is for internal usage only.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities List<GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthority>
    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.
    customCertificates List<GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificate>
    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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Integer
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort 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. See Secure property requirements for guidance.
    ipVersion 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.
    netStorage GetPropertyRulesBuilderRulesV20230530BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Integer
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    compress boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthority[]
    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.
    customCertificates GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificate[]
    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.
    customForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues string[]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    netStorage GetPropertyRulesBuilderRulesV20230530BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor string
    Specifies which certificate to trust.
    originId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace string
    Specifies replacement text for what saasRegex matches.
    saasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    saasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities string[]
    templateUuid string
    This option is for internal usage only.
    trueClientIpClientSetting boolean
    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.
    trueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey boolean
    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.
    verificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cache_key_hostname str
    Specifies the hostname to use when forming a cache key.
    compress bool
    Enables gzip compression for non-NetStorage origins.
    custom_certificate_authorities Sequence[GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthority]
    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[GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificate]
    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_host_header str
    This specifies the name of the custom host header the edge server should pass to the origin.
    custom_valid_cn_values Sequence[str]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enable_true_client_ip bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forward_host_header str
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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. See Secure 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 GetPropertyRulesBuilderRulesV20230530BehaviorOriginNetStorage
    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_to_honor str
    Specifies which certificate to trust.
    origin_id str
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id 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.
    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_enabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saas_cname_level int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saas_query_string str
    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_enabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standard_certificate_authorities Sequence[str]
    template_uuid str
    This option is for internal usage only.
    true_client_ip_client_setting bool
    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_ip_header str
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    use_unique_cache_key bool
    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.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities 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.
    customCertificates 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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort Number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    netStorage Property Map
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristics

    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings List<string>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings []string
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Integer
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    accessKeyEncryptedStorage boolean
    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.
    adcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod string
    Specifies the authentication method.
    authenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion string
    awsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings string[]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo string
    Provides a region used by Akamai Direct Connection.
    encodingVersion number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService string
    gcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag boolean
    locked boolean
    Indicates 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.
    originLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag boolean
    roleArn string
    secretKey string
    Specifies the shared secret key.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    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_encrypted_storage bool
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    aws_access_key_id str
    Specifies active access key ID linked to your AWS account.
    aws_access_key_version_guid str
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    aws_ar_region str
    aws_host str
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    aws_region str
    This specifies the AWS region code of the location where your bucket resides.
    aws_secret_access_key str
    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_strings Sequence[str]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    direct_connect_geo str
    Provides a region used by Akamai Direct Connection.
    encoding_version int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    end_point_service str
    gcs_access_key_version_guid str
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcs_hmac_key_access_id str
    Specifies the active access ID linked to your Google account.
    gcs_hmac_key_secret str
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostname_tag bool
    locked bool
    Indicates 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.
    origin_location_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    property_id_tag bool
    role_arn str
    secret_key str
    Specifies the shared secret key.
    template_uuid str
    This option is for internal usage only.
    use_custom_sign_string bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCharacteristicsWsd

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificate

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthority

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthorityIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateAuthoritySubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginCustomCertificateSubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryMethod

    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode string
    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.
    recoveryMethod string
    Specifies the recovery method.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_code str
    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.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginFailureRecoveryPolicy

    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Integer
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Integer
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Integer
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    binaryEquivalentContent boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval number
    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.
    monitorOriginResponsiveness boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    tuningParameters 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_content bool
    Synchronizes content between the primary and backup origins, byte for byte.
    enable_ip_avoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled bool
    Activates and configures a recovery policy.
    ip_avoidance_error_threshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ip_avoidance_retry_interval int
    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_responsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitor_response_codes1s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes2s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes3s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitor_status_codes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes1_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes1_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes1_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes2_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes2_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes2_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes3_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes3_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes3_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_custom_timeout int
    Specify a custom timeout, from 1 to 10 seconds.
    origin_responsiveness_enable_recovery bool
    Enables a recovery action for a specific failure condition.
    origin_responsiveness_enable_retry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    origin_responsiveness_monitoring str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    origin_responsiveness_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_timeout str
    The timeout threshold that triggers a retry or recovery action.
    status_code_monitoring1 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring2 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring3 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.
    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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Number
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginIpAcl

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorOriginNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230530BehaviorPersistentClientConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorPersistentConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorPersonallyIdentifiableInformation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPhasedRelease

    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes List<string>
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes []string
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes string[]
    Defines the set of failure codes that initiate the failover response.
    failoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate string
    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.
    populationRefresh boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    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_codes Sequence[str]
    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.
    is_shared_policy 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.
    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.
    population_cookie_type 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 effectively NONE.
    population_duration str
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    population_expiration_date str
    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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPhasedReleaseCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorPreconnect

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Preconnectlists List<string>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Preconnectlists []string
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists string[]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists Sequence[str]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPredictiveContentDelivery

    Enabled bool
    Enables the predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPredictivePrefetching

    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled boolean
    Enables the predictive prefetching 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracy_target str
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled bool
    Enables the predictive prefetching 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.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPrefetch

    Enabled bool
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPrefetchable

    Enabled bool
    Allows matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked bool
    Indicates that your 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorPrefreshCache

    Enabled bool
    Enables the cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval Integer
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    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 cache prefreshing 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.
    prefreshval Number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorQuality

    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Integer
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize string
    contentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType string
    country string
    deliveryFormat string
    deliveryType string
    downloadType string
    endUserLocation 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.
    maximumConcurrentUsers string
    objectSize string
    optimizeFor string
    originSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution string
    refreshRate string
    segmentDuration number
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audience_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalog_size str
    content_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    content_type str
    country str
    delivery_format str
    delivery_type str
    download_type str
    end_user_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.
    maximum_concurrent_users str
    object_size str
    optimize_for str
    origin_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularity_distribution str
    refresh_rate str
    segment_duration int
    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.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Number
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorQuicBeta

    Enabled bool
    Enables QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Integer
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quic_offer_percentage int
    The percentage of responses for which to allow QUIC sessions.
    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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRandomSeek

    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv boolean
    Enables random seek optimization in FLV files.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 boolean
    Enables random seek optimization in MP4 files.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv bool
    Enables random seek optimization in FLV files.
    locked bool
    Indicates 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
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 bool
    Enables random seek optimization in MP4 files.
    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.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRapid

    Enabled bool
    Enables API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorReadTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked bool
    Indicates that your 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.

    GetPropertyRulesBuilderRulesV20230530BehaviorRealTimeReporting

    Advanced bool
    Enables advanced options.
    BeaconSamplingPercentage double
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    BeaconSamplingPercentage float64
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage Double
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage number
    Specifies the percentage for sampling.
    enabled boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beacon_sampling_percentage float
    Specifies the percentage for sampling.
    enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked bool
    Indicates that your 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.
    advanced Boolean
    Enables advanced options.
    beaconSamplingPercentage Number
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRealUserMonitoring

    Enabled bool
    When enabled, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked bool
    Indicates that your 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRedirect

    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Integer
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol string
    Choose the protocol for the redirect URL.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    queryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode number
    Specify the redirect's response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination_hostname str
    Specify how to change the requested hostname, independently from the pathname.
    destination_hostname_other str
    Specifies the full hostname with which to replace the current hostname.
    destination_hostname_sibling str
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destination_hostname_subdomain str
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destination_path str
    Specify how to change the requested pathname, independently from the hostname.
    destination_path_other str
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destination_path_prefix str
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destination_path_suffix str
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destination_path_suffix_status str
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destination_protocol str
    Choose the protocol for the redirect URL.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobile_default_choice str
    Either specify a default response for mobile browsers, or customize your own.
    query_string str
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    response_code int
    Specify the redirect's 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.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Number
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRedirectplus

    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Integer
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled boolean
    Enables the redirect 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.
    responseCode number
    Assigns the status code for the redirect response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination str
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled bool
    Enables the redirect 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.
    response_code int
    Assigns the status code for the redirect 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.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Number
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRefererChecking

    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains List<string>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains []string
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains string[]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled boolean
    Enables the referer-checking 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.
    strict boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_children bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains Sequence[str]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled bool
    Enables the referer-checking 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.
    strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    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.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRemoveQueryParameter

    Locked bool
    Indicates 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 parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Parameters []string
    Specifies parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters List<String>
    Specifies parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters string[]
    Specifies parameters to remove from the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters Sequence[str]
    Specifies parameters to remove from 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.
    locked Boolean
    Indicates 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 parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRemoveVary

    Enabled bool
    When enabled, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked bool
    Indicates that your 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorReport

    Cookies List<string>
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Cookies []string
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies string[]
    This specifies the set of cookies names whose values you want to log.
    customLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage boolean
    Log the Accept-Language header.
    logCookies string
    Specifies the set of cookies to log.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    logEdgeIp boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost boolean
    Log the Host header.
    logReferer boolean
    Log the Referer header.
    logUserAgent boolean
    Log the User-Agent header.
    logXForwardedFor boolean
    Log any X-Forwarded-For request header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies Sequence[str]
    This specifies the set of cookies names whose values you want to log.
    custom_log_field str
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked bool
    Indicates 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_accept_language bool
    Log the Accept-Language header.
    log_cookies str
    Specifies the set of cookies to log.
    log_custom_log_field bool
    Whether to append additional custom data to each log line.
    log_edge_ip bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    log_host bool
    Log the Host header.
    log_referer bool
    Log the Referer header.
    log_user_agent bool
    Log the User-Agent header.
    log_x_forwarded_for bool
    Log any X-Forwarded-For request 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.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRequestControl

    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Integer
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Integer
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode number
    Specifies the response status code for the branded deny action.
    branded403Url string
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403_file str
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403_status_code int
    Specifies the response status code for the branded deny action.
    branded403_url str
    Specifies the redirect URL for the branded deny action.
    branded_deny_cache_ttl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enable_branded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled bool
    Enables the Request Control Cloudlet.
    is_shared_policy 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.
    net_storage GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    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.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Number
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage Property Map
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorRequestControlNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230530BehaviorRequestTypeMarker

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType string
    Specifies the type of request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    request_type str
    Specifies the type of 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizer

    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorResourceOptimizerExtendedCompatibility

    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures boolean
    Enables additional support and error handling.
    enabled boolean
    Enables the Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_all_features bool
    Enables additional support and error handling.
    enabled bool
    Enables the Resource Optimizer 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.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Integer
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode number
    The HTTP status code to replace the existing one.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    status_code int
    The HTTP status code to replace the existing one.
    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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Number
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorResponseCookie

    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled boolean
    Allows you to set a response cookie.
    expirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires string
    Sets various ways to specify when the cookie expires.
    format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid string
    This option is for internal usage only.
    type string
    What type of value to assign.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookie_name str
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    default_domain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    default_path bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain str
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration str
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled bool
    Allows you to set a response cookie.
    expiration_date str
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires str
    Sets various ways to specify when the cookie expires.
    format str
    When the type of cookie is set to UNIQUE, this sets the date format.
    http_only bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path str
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    same_site str
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    template_uuid str
    This option is for internal usage only.
    type str
    What type of value to assign.
    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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.

    GetPropertyRulesBuilderRulesV20230530BehaviorRestrictObjectCaching

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_size str
    Specifies a fixed maximum size of non-HTML content to cache.
    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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorReturnCacheStatus

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    response_header_name str
    Specifies the name of the HTTP header in which to report the cache status 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRewriteUrl

    Behavior string
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString boolean
    When enabled, retains the original path's query parameters.
    locked boolean
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keep_query_string bool
    When enabled, retains the original path's query parameters.
    locked bool
    Indicates 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 str
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    match_multiple bool
    When enabled, replaces all potential matches rather than only the first.
    match_regex str
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    target_path str
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    target_path_prepend str
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    target_regex str
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    target_url str
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorRumCustom

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Integer
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rum_group_name str
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rum_sample_rate int
    Specifies the percentage of web traffic to include in your RUM 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSaasDefinitions

    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    applicationAction string
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie string
    This specifies the name of the cookie that identifies the application.
    applicationQueryString string
    This names the query parameter that identifies the application.
    applicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction string
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie string
    This specifies the name of the cookie that identifies the customer.
    customerQueryString string
    This names the query parameter that identifies the customer.
    customerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid string
    This option is for internal usage only.
    usersAction string
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie string
    This specifies the name of the cookie that identifies the user.
    usersQueryString string
    This names the query parameter that identifies the user.
    usersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    application_action str
    Specifies the request component that identifies a SaaS application.
    application_cname_enabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    application_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    application_cookie str
    This specifies the name of the cookie that identifies the application.
    application_query_string str
    This names the query parameter that identifies the application.
    application_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    application_replace str
    Specifies a string to replace the request's application ID matched by applicationRegex.
    application_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customer_action str
    Specifies the request component that identifies a SaaS customer.
    customer_cname_enabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customer_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    customer_cookie str
    This specifies the name of the cookie that identifies the customer.
    customer_query_string str
    This names the query parameter that identifies the customer.
    customer_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customer_replace str
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customer_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.
    users_action str
    Specifies the request component that identifies a SaaS user.
    users_cname_enabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    users_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    users_cookie str
    This specifies the name of the cookie that identifies the user.
    users_query_string str
    This names the query parameter that identifies the user.
    users_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    users_replace str
    Specifies a string to replace the request's user ID matched by usersRegex.
    users_title 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudClient

    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader string
    Specifies where the Host header is defined.
    originType string
    Specifies where the origin is.
    sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_override_origin_cache_key bool
    When enabled, overrides the forwarding origin's cache key.
    connector_id str
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked bool
    Indicates 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_host_header str
    Specifies where the Host header is defined.
    origin_type str
    Specifies where the origin is.
    sf3c_origin_host str
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3c_origin_host_header str
    This specifies the hostname or IP address of the custom Salesforce host 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.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProvider

    Enabled bool
    Enables Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked bool
    Indicates that your 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSalesForceCommerceCloudProviderHostHeader

    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource string
    Specify where the host header derives 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    host_header_source str
    Specify where the host header derives 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.
    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.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSavePostDcaProcessing

    Enabled bool
    Enables processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    enabled Boolean
    Enables processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorScheduleInvalidation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod string
    Specifies how to invalidate the content.
    repeat boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start string
    The UTC date and time when matching cached content is to expire.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refresh_method str
    Specifies how to invalidate the content.
    repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeat_interval str
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start str
    The UTC date and time when matching cached content is to expire.
    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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorScriptManagement

    Enabled bool
    Enables the Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Integer
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid string
    This option is for internal usage only.
    timestamp number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker str
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    template_uuid str
    This option is for internal usage only.
    timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedContentProtection

    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts List<string>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles List<string>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts []string
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles []string
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Integer
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption boolean
    Whether to enable DASH Media Encryption.
    dataPayload boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled boolean
    Enables the segmented content protection behavior.
    fieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts string[]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles string[]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption boolean
    Enables HLS Segment Encryption.
    ip boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid string
    This option is for internal usage only.
    tokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dash_media_encryption bool
    Whether to enable DASH Media Encryption.
    data_payload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enable_token_in_uri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled bool
    Enables the segmented content protection behavior.
    field_carry_over str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    header_for_salts Sequence[str]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hls_master_manifest_files Sequence[str]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hls_media_encryption bool
    Enables HLS Segment Encryption.
    ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key str
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked bool
    Indicates 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_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revoked_list_id int
    Identifies the TokenAuth tokens to block from accessing your content.
    salt str
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    session_id bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    template_uuid str
    This option is for internal usage only.
    token_auth_hls_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_authentication_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_revocation_enabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    token_revocation_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transition_key str
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    use_advanced bool
    Allows you to specify advanced transitionKey and salt options.
    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.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaOptimization

    Behavior string
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType string
    The type of DVR.
    dvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime string
    This specifies when the live media event ends.
    liveType string
    The type of live 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.
    showAdvanced boolean
    Allows you to configure advanced media options.
    startTime string
    This specifies when the live media event begins.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvr_type str
    The type of DVR.
    dvr_window str
    Set the duration for your media, or 0m if a DVR is not required.
    enable_ull_streaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    end_time str
    This specifies when the live media event ends.
    live_type str
    The type of live 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.
    show_advanced bool
    Allows you to configure advanced media options.
    start_time str
    This specifies when the live media event begins.
    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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSegmentedMediaStreamingPrefetch

    Enabled bool
    Enables media stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked bool
    Indicates that your 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSetVariable

    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex string
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber string
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber string
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex string
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex string
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber string
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber string
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex string
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex String
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Integer
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Integer
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Integer
    Specifies a maximum value for the generated integer.
    maxRandomNumber String
    Specifies the upper bound of the random number.
    min Integer
    Specifies a minimum value for the generated integer.
    minRandomNumber String
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Integer
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex String
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm string
    Specifies the algorithm to apply.
    caseSensitive boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName string
    Specifies the certificate's content.
    cookieName string
    Specifies the name of the cookie to extract.
    deviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode string
    Specifies the encryption mode.
    endIndex string
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation string
    This specifies from where to get the value.
    forceChars string
    Specifies characters to encode, possibly overriding the default set.
    formatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator string
    This specifies the type of value to generate.
    globalSubstitution boolean
    Replaces all matches in the string, not just the first.
    headerName string
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion string
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked boolean
    Indicates 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 number
    Specifies a maximum value for the generated integer.
    maxRandomNumber string
    Specifies the upper bound of the random number.
    min number
    Specifies a minimum value for the generated integer.
    minRandomNumber string
    Specifies the lower bound of the random number.
    nonce string
    Specifies the one-time number used for encryption.
    numberOfBytes number
    Specifies the number of random hex bytes to generate.
    operandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    separator string
    Specifies the character that separates pairs of values within the string.
    setCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    startIndex string
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid string
    This option is for internal usage only.
    transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource string
    Determines how you want to set the value.
    variableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm str
    Specifies the algorithm to apply.
    case_sensitive bool
    Enabling this makes all matches case sensitive.
    certificate_field_name str
    Specifies the certificate's content.
    cookie_name str
    Specifies the name of the cookie to extract.
    device_profile str
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryption_key str
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryption_mode str
    Specifies the encryption mode.
    end_index str
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    except_chars str
    Specifies characters not to encode, possibly overriding the default set.
    extract_location str
    This specifies from where to get the value.
    force_chars str
    Specifies characters to encode, possibly overriding the default set.
    format_string str
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator str
    This specifies the type of value to generate.
    global_substitution bool
    Replaces all matches in the string, not just the first.
    header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    hmac_algorithm str
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmac_key str
    Specifies the secret to use in generating the base64-encoded digest.
    initialization_vector str
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ip_version str
    Specifies the IP version under which a subnet mask generates.
    ipv4_prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6_prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    location_id str
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    max_random_number str
    Specifies the upper bound of the random number.
    min int
    Specifies a minimum value for the generated integer.
    min_random_number str
    Specifies the lower bound of the random number.
    nonce str
    Specifies the one-time number used for encryption.
    number_of_bytes int
    Specifies the number of random hex bytes to generate.
    operand_one str
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    param_name str
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    path_component_offset str
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prepend_bytes bool
    Specifies a number of random bytes to prepend to the key.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the value.
    regex str
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement str
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    response_header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    separator str
    Specifies the character that separates pairs of values within the string.
    set_cookie_name str
    Specifies the name of the origin's Set-Cookie response header.
    start_index str
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    sub_string str
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    template_uuid str
    This option is for internal usage only.
    transform str
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    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_source str
    Determines how you want to set the value.
    variable_name str
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variable_value str
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex String
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Number
    Specifies a maximum value for the generated integer.
    maxRandomNumber String
    Specifies the upper bound of the random number.
    min Number
    Specifies a minimum value for the generated integer.
    minRandomNumber String
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Number
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex String
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.

    GetPropertyRulesBuilderRulesV20230530BehaviorSimulateErrorCode

    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType string
    Specifies the type of 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.
    templateUuid string
    This option is for internal usage only.
    timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    error_type str
    Specifies the type of 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.
    timeout str
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    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.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSiteShield

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20230530BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20230530BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230530BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230530BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230530BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap Property Map
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorSiteShieldSsmap

    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String
    chinaCdnMap string
    hasMixedHosts boolean
    name string
    src string
    srmap string
    value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String

    GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigration

    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Integer
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Integer
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration number
    Specifies the number cache sharing days.
    cacheSharingStartTime string
    Specifies when to start cache sharing.
    enabled boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration number
    Specifies the number of days to migrate the cache.
    migrationFrom string
    What kind of traffic you're migrating from.
    migrationStartTime string
    Specifies when to start migrating the cache.
    tdLocation string
    Specifies the tieredDistribution location.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_https_downgrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allow_https_upgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cache_sharing_duration int
    Specifies the number cache sharing days.
    cache_sharing_start_time str
    Specifies when to start cache sharing.
    enabled bool
    Allows migration to Standard TLS.
    is_certificate_sni_only bool
    Sets whether your new certificate is SNI-only.
    is_tiered_distribution_used bool
    Allows you to align traffic to various tieredDistribution areas.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migration_duration int
    Specifies the number of days to migrate the cache.
    migration_from str
    What kind of traffic you're migrating from.
    migration_start_time str
    Specifies when to start migrating the cache.
    td_location str
    Specifies the tieredDistribution location.
    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.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Number
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Number
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorStandardTlsMigrationOverride

    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorStrictHeaderParsing

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strict_mode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers 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.
    valid_mode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.

    GetPropertyRulesBuilderRulesV20230530BehaviorSubCustomer

    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey boolean
    Allows you to set which query parameters are included in the cache key.
    caching boolean
    Modifies content caching rules.
    contentCompressor boolean
    Allows compression of subcustomer content.
    dynamicWebContent boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery boolean
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery boolean
    Enables delivery of media assets to subcustomers.
    origin boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid string
    This option is for internal usage only.
    tokenAuthorization boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    access_control bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cache_key bool
    Allows you to set which query parameters are included in the cache key.
    caching bool
    Modifies content caching rules.
    content_compressor bool
    Allows compression of subcustomer content.
    dynamic_web_content bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geo_location bool
    Sets subcustomers' location-based whitelists or blacklists.
    ip bool
    Sets subcustomers' IP whitelists or blacklists.
    large_file_delivery bool
    Enables large file delivery for subcustomers.
    live_video_delivery bool
    locked bool
    Indicates 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_path bool
    Modifies a subcustomer's request path.
    on_demand_video_delivery bool
    Enables delivery of media assets to subcustomers.
    origin bool
    Allows you to assign origin hostnames for customers.
    partner_domain_suffix str
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    refresh_content bool
    Allows you to reschedule when content validates for subcustomers.
    site_failover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    template_uuid str
    This option is for internal usage only.
    token_authorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    web_application_firewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.

    GetPropertyRulesBuilderRulesV20230530BehaviorSureRoute

    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride boolean
    customMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    testObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus string
    Specifies which hostname to use.
    type string
    Specifies the set of edge servers used to test routes.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_fcm_parent_override bool
    custom_map str
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    custom_stat_key str
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enable_custom_key bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    force_ssl_forward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    race_stat_ttl str
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    sr_download_link_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.
    test_object_url str
    Specifies the path and filename for your origin's test object to use in races to test routes.
    to_host str
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    to_host_status str
    Specifies which hostname to use.
    type str
    Specifies the set of edge servers used to test routes.
    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.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorTcpOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorTeaLeaf

    Enabled bool
    When enabled, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Integer
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibm_customer_id int
    The integer identifier for the IBM Tealeaf Connector account.
    limit_to_dynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistribution

    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked bool
    Indicates that your 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.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionAdvanced

    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall boolean
    enabled boolean
    When enabled, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method string
    policy string
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall bool
    enabled bool
    When enabled, activates tiered distribution.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method str
    policy str
    template_uuid str
    This option is for internal usage only.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorTieredDistributionCustomization

    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled boolean
    Enables custom maps.
    customMapName string
    Specifies the custom map name.
    hashAlgorithm string
    Specifies the hash algorithm.
    location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate string
    Specifies when the map migration should end.
    migrationStartDate string
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart string
    Specifies a numeric serial start value.
    templateUuid string
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapper_map_migration_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    custom_map_enabled bool
    Enables custom maps.
    custom_map_name str
    Specifies the custom map name.
    hash_algorithm str
    Specifies the hash algorithm.
    location str
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    map_migration_enabled bool
    Enables migration of the custom map to Cloud Wrapper.
    migration_end_date str
    Specifies when the map migration should end.
    migration_start_date str
    Specifies when to start migrating the map.
    migration_within_cw_maps_enabled bool
    Enables migration within Cloud Wrapper maps.
    serial_end str
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serial_start str
    Specifies a numeric serial start value.
    template_uuid str
    This option is for internal usage only.
    tier1_title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked bool
    Indicates that your 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.

    GetPropertyRulesBuilderRulesV20230530BehaviorUidConfiguration

    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled boolean
    Allows you to extract UIDs from client requests.
    extractLocation string
    Where to extract the UID value from.
    headerName string
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled bool
    Allows you to extract UIDs from client requests.
    extract_location str
    Where to extract the UID value from.
    header_name str
    This specifies the name of the HTTP header from which to extract the UID value.
    legal_text 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.
    query_parameter_name str
    This specifies the name of the query parameter from which to extract the UID 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 rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.

    GetPropertyRulesBuilderRulesV20230530BehaviorValidateEntityTag

    Enabled bool
    Enables the ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebToken

    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation string
    Specify from where to extract the JWT value.
    headerName string
    This specifies the name of the header from which to extract the JWT value.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extract_location str
    Specify from where to extract the JWT value.
    header_name str
    This specifies the name of the header from which to extract the JWT value.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates 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_name str
    This specifies the name of the query parameter from which to extract the JWT 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.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorVerifyJsonWebTokenForDcp

    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.
    authorizations string
    This specifies the authorization group name.
    clientId string
    This specifies the claim name.
    customHeader boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation string
    Specifies where to get the JWT value from.
    extractUserName boolean
    Allows you to extract the user name stored in the JWT.
    headerName string
    This specifies the name of the header to extract the JWT value from.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    userName string
    This specifies the user 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.
    authorizations str
    This specifies the authorization group name.
    client_id str
    This specifies the claim name.
    custom_header bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enable_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extract_authorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    extract_client_id bool
    Allows you to extract the client ID claim name stored in JWT.
    extract_location str
    Specifies where to get the JWT value from.
    extract_user_name bool
    Allows you to extract the user name stored in the JWT.
    header_name str
    This specifies the name of the header to extract the JWT value from.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primary_location str
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the JWT value.
    template_uuid str
    This option is for internal usage only.
    user_name str
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorVerifyTokenAuthorization

    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location string
    Specifies where to find the token in the incoming request.
    locationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid string
    This option is for internal usage only.
    transitionKey string
    Specifies a transition key as a hex value.
    useAdvanced boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm str
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escape_hmac_inputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    failure_response bool
    When enabled, sends an HTTP error when an authentication test fails.
    ignore_query_string bool
    Enabling this removes the query string from the URL used to form an encryption key.
    key str
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location str
    Specifies where to find the token in the incoming request.
    location_id str
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt str
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    template_uuid str
    This option is for internal usage only.
    transition_key str
    Specifies a transition key as a hex value.
    use_advanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    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.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoom

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorVirtualWaitingRoomWithEdgeWorkers

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritization

    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders List<string>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams List<string>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders []string
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams []string
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Integer
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Integer
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Integer
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Integer
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Visitor Prioritization 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.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp boolean
    Allows IP addresses to identify users.
    userIdentificationByParams boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders string[]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams string[]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowed_user_cookie_advanced bool
    Sets advanced configuration options for the allowed user's cookie.
    allowed_user_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowed_user_cookie_domain str
    Specifies a domain for an allowed user cookie.
    allowed_user_cookie_domain_type str
    Specify with allowedUserCookieAdvanced enabled.
    allowed_user_cookie_duration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowed_user_cookie_enabled bool
    Sets a cookie for users who have been allowed through to the site.
    allowed_user_cookie_http_only bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowed_user_cookie_label str
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowed_user_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowed_user_cookie_refresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowed_user_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Visitor Prioritization 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.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by the values of GET or POST request headers.
    user_identification_by_ip bool
    Allows IP addresses to identify users.
    user_identification_by_params bool
    When enabled, identifies users by the values of GET or POST request parameters.
    user_identification_key_cookie str
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    user_identification_key_headers Sequence[str]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    user_identification_key_params Sequence[str]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    user_identification_title 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.
    waiting_room_cache_ttl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waiting_room_cookie_advanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waiting_room_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waiting_room_cookie_domain str
    Specifies a domain for the waiting room cookie.
    waiting_room_cookie_domain_type str
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waiting_room_cookie_duration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waiting_room_cookie_enabled bool
    Enables a cookie to track a waiting room assignment.
    waiting_room_cookie_http_only bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waiting_room_cookie_label str
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waiting_room_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waiting_room_cookie_share_label bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waiting_room_cp_code GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waiting_room_directory str
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waiting_room_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_net_storage GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waiting_room_status_code int
    Specifies the response code for requests sent to the waiting room.
    waiting_room_use_cp_code bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode Property Map
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage Property Map
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifo

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies how to set the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationFifoStandalone

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530BehaviorVisitorPrioritizationWaitingRoomNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230530BehaviorWatermarking

    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid string
    This option is for internal usage only.
    tokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 string
    Specifies a unique identifier for the first public key.
    verificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 string
    Specifies the first public key in its entirety.
    verificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    ab_variant_location str
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryption_password1 str
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryption_password2 str
    Provides the secondary password you can use to rotate passwords.
    decryption_password_id1 str
    Specifies a label that corresponds to the primary password.
    decryption_password_id2 str
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable bool
    Enables the watermarking 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.
    miscellaneous_settings_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    pattern_decryption_enable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    pattern_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signature_verification_enable bool
    When enabled, you can verify the signature in your watermarking token.
    template_uuid str
    This option is for internal usage only.
    token_signing_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    use_original_as_a bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    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_key_id1 str
    Specifies a unique identifier for the first public key.
    verification_key_id2 str
    Specifies a unique identifier for the optional second public key.
    verification_public_key1 str
    Specifies the first public key in its entirety.
    verification_public_key2 str
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.

    GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewall

    FirewallConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FirewallConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewall_configuration GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    firewallConfiguration Property Map
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorWebApplicationFirewallFirewallConfiguration

    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Integer
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId number
    fileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    config_id int
    file_name str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Number
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior

    GetPropertyRulesBuilderRulesV20230530BehaviorWebSockets

    Enabled bool
    Enables WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530BehaviorWebdav

    Enabled bool
    Enables the WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530Criterion

    AdvancedImMatch GetPropertyRulesBuilderRulesV20230530CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20230530CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20230530CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20230530CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20230530CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20230530CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20230530CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20230530CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20230530CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20230530CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20230530CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20230530CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20230530CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20230530CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20230530CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20230530CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20230530CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20230530CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20230530CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20230530CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20230530CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20230530CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20230530CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20230530CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20230530CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20230530CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20230530CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20230530CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20230530CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20230530CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20230530CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20230530CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20230530CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20230530CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20230530CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20230530CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20230530CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20230530CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20230530CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20230530CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230530CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230530CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    AdvancedImMatch GetPropertyRulesBuilderRulesV20230530CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20230530CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20230530CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20230530CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20230530CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20230530CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20230530CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20230530CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20230530CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20230530CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20230530CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20230530CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20230530CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20230530CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20230530CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20230530CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20230530CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20230530CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20230530CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20230530CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20230530CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20230530CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20230530CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20230530CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20230530CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20230530CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20230530CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20230530CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20230530CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20230530CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20230530CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20230530CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20230530CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20230530CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20230530CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20230530CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20230530CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20230530CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20230530CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20230530CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230530CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230530CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20230530CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230530CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230530CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20230530CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20230530CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20230530CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20230530CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20230530CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20230530CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20230530CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20230530CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20230530CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20230530CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20230530CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20230530CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230530CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230530CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20230530CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20230530CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20230530CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20230530CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20230530CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230530CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20230530CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230530CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20230530CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20230530CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20230530CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20230530CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20230530CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20230530CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20230530CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20230530CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20230530CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230530CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20230530CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20230530CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20230530CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20230530CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20230530CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230530CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230530CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20230530CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230530CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230530CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20230530CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20230530CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20230530CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20230530CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20230530CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20230530CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20230530CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20230530CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20230530CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20230530CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20230530CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20230530CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230530CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230530CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20230530CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20230530CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20230530CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20230530CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20230530CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230530CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20230530CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230530CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20230530CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20230530CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20230530CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20230530CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20230530CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20230530CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20230530CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20230530CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20230530CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230530CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20230530CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20230530CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20230530CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20230530CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20230530CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230530CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230530CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advanced_im_match GetPropertyRulesBuilderRulesV20230530CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230530CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230530CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    china_cdn_region GetPropertyRulesBuilderRulesV20230530CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    client_certificate GetPropertyRulesBuilderRulesV20230530CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    client_ip GetPropertyRulesBuilderRulesV20230530CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    client_ip_version GetPropertyRulesBuilderRulesV20230530CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudlets_origin GetPropertyRulesBuilderRulesV20230530CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    content_delivery_network GetPropertyRulesBuilderRulesV20230530CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    content_type GetPropertyRulesBuilderRulesV20230530CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    device_characteristic GetPropertyRulesBuilderRulesV20230530CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmd_auth_groups GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmd_auth_scheme GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmd_is_authenticated GetPropertyRulesBuilderRulesV20230530CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmd_username GetPropertyRulesBuilderRulesV20230530CriterionEcmdUsername
    This criterion can be used in includes.
    edge_workers_failure GetPropertyRulesBuilderRulesV20230530CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    file_extension GetPropertyRulesBuilderRulesV20230530CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230530CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230530CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    match_advanced GetPropertyRulesBuilderRulesV20230530CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    match_cp_code GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    match_response_code GetPropertyRulesBuilderRulesV20230530CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    match_variable GetPropertyRulesBuilderRulesV20230530CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadata_stage GetPropertyRulesBuilderRulesV20230530CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    origin_timeout GetPropertyRulesBuilderRulesV20230530CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230530CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    query_string_parameter GetPropertyRulesBuilderRulesV20230530CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230530CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recovery_config GetPropertyRulesBuilderRulesV20230530CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regular_expression GetPropertyRulesBuilderRulesV20230530CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    request_cookie GetPropertyRulesBuilderRulesV20230530CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    request_header GetPropertyRulesBuilderRulesV20230530CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    request_method GetPropertyRulesBuilderRulesV20230530CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    request_protocol GetPropertyRulesBuilderRulesV20230530CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    request_type GetPropertyRulesBuilderRulesV20230530CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    response_header GetPropertyRulesBuilderRulesV20230530CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    server_location GetPropertyRulesBuilderRulesV20230530CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230530CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    token_authorization GetPropertyRulesBuilderRulesV20230530CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    user_agent GetPropertyRulesBuilderRulesV20230530CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    user_location GetPropertyRulesBuilderRulesV20230530CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    user_network GetPropertyRulesBuilderRulesV20230530CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variable_error GetPropertyRulesBuilderRulesV20230530CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtual_waiting_room_request GetPropertyRulesBuilderRulesV20230530CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitor_prioritization_request GetPropertyRulesBuilderRulesV20230530CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch Property Map
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket Property Map
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability Property Map
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion Property Map
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate Property Map
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp Property Map
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion Property Map
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin Property Map
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork Property Map
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType Property Map
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic Property Map
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups Property Map
    This criterion can be used in includes.
    ecmdAuthScheme Property Map
    This criterion can be used in includes.
    ecmdIsAuthenticated Property Map
    This criterion can be used in includes.
    ecmdUsername Property Map
    This criterion can be used in includes.
    edgeWorkersFailure Property Map
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension Property Map
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename Property Map
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname Property Map
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced Property Map
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode Property Map
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode Property Map
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable Property Map
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage Property Map
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout Property Map
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path Property Map
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter Property Map
    Matches query string field names or values. This criterion can be used in includes.
    random Property Map
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig Property Map
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression Property Map
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie Property Map
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod Property Map
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol Property Map
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType Property Map
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation Property Map
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time Property Map
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization Property Map
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent Property Map
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation Property Map
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork Property Map
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError Property Map
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest Property Map
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest Property Map
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.

    GetPropertyRulesBuilderRulesV20230530CriterionAdvancedImMatch

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the match's scope.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the match's scope.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionBucket

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage Integer
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage number
    Specifies the percentage of requests to match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage int
    Specifies the percentage of requests to match.
    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.
    percentage Number
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionCacheability

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    match_operator str
    Specifies the match's logic.
    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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_CACHE).

    GetPropertyRulesBuilderRulesV20230530CriterionChinaCdnRegion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionClientCertificate

    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    isCertificatePresent boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    is_certificate_present bool
    Executes rule behaviors only if a client certificate authenticates requests.
    is_certificate_valid str
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked bool
    Indicates that your 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.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionClientIp

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    IP or CIDR block, for example: 71.92.0.0/14.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    useHeaders boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked bool
    Indicates 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_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    template_uuid str
    This option is for internal usage only.
    use_headers bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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.
    values Sequence[str]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.

    GetPropertyRulesBuilderRulesV20230530CriterionClientIpVersion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    useXForwardedFor boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked bool
    Indicates that your 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_x_forwarded_for bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.

    GetPropertyRulesBuilderRulesV20230530CriterionCloudletsOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The Cloudlets Origins identifier, limited to alphanumeric and underscore 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionContentDeliveryNetwork

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network string
    Match the network.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network str
    Match the network.
    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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionContentType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Content-Type response header value, for example text/html.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for all values.
    matchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Content-Type response header value, for example text/html.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for all values.
    match_operator str
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    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.
    values Sequence[str]
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.

    GetPropertyRulesBuilderRulesV20230530CriterionDeviceCharacteristic

    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues List<string>
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues []string
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Integer
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic string
    Aspect of the device or browser 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.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues string[]
    When the characteristic expects a string, this specifies the set of values.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue string
    When the characteristic expects a version number, this specifies it as a string.
    boolean_value bool
    When the characteristic expects a boolean value, this specifies the value.
    characteristic str
    Aspect of the device or browser 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_case_sensitive bool
    Sets a case-sensitive match for the stringValue field.
    match_wildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numeric_match_operator str
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numeric_value int
    When the characteristic expects a numeric value, this specifies the number.
    string_match_operator str
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    string_values Sequence[str]
    When the characteristic expects a string, this specifies the set of values.
    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.
    version_match_operator str
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    version_value str
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.

    GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthGroups

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked bool
    Indicates 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_operator 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.
    value str
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230530CriterionEcmdAuthScheme

    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    auth_scheme 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.
    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.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionEcmdIsAuthenticated

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionEcmdUsername

    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    match_operator 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.
    value str
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230530CriterionEdgeWorkersFailure

    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus string
    Specify execution status.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    exec_status str
    Specify execution status.
    locked bool
    Indicates that your 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.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionFileExtension

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.

    GetPropertyRulesBuilderRulesV20230530CriterionFilename

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the values field.
    matchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the values field.
    match_operator str
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    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.
    values Sequence[str]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.

    GetPropertyRulesBuilderRulesV20230530CriterionHostname

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked bool
    Indicates 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_operator str
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.

    GetPropertyRulesBuilderRulesV20230530CriterionMatchAdvanced

    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml string
    An XML string that closes the relevant block.
    description string
    A 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.
    openXml string
    An XML string that opens the relevant block.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    close_xml str
    An XML string that closes the relevant block.
    description str
    A 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.
    open_xml str
    An XML string that opens the relevant block.
    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.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to match the CP code, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230530CriterionMatchCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230530CriterionMatchResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A set of response codes to match, for example ["404","500"].
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator string
    Matches numeric range or a specified set of values.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A set of response codes to match, for example ["404","500"].
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    match_operator str
    Matches numeric range or a specified set of values.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    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.
    values Sequence[str]
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].

    GetPropertyRulesBuilderRulesV20230530CriterionMatchVariable

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues List<string>
    Specifies an array of matching strings.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues []string
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound string
    Specifies the range's numeric minimum value.
    matchCaseSensitive boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound string
    Specifies the range's numeric maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression string
    Specifies a single matching string.
    variableName string
    The name of the variable to match.
    variableValues string[]
    Specifies an array of matching strings.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound str
    Specifies the range's numeric minimum value.
    match_case_sensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    match_operator str
    The type of match, based on which you use different options to specify the match criteria.
    match_wildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound str
    Specifies the range's numeric maximum value.
    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_expression str
    Specifies a single matching string.
    variable_name str
    The name of the variable to match.
    variable_values Sequence[str]
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.

    GetPropertyRulesBuilderRulesV20230530CriterionMetadataStage

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Compares the current rule with the specified metadata stage.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked bool
    Indicates 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_operator str
    Compares the current rule with the specified metadata stage.
    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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.

    GetPropertyRulesBuilderRulesV20230530CriterionOriginTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specifies a single required ORIGIN_TIMED_OUT 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionPath

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of the values array.
    normalize boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of the values array.
    normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    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.
    values Sequence[str]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.

    GetPropertyRulesBuilderRulesV20230530CriterionQueryStringParameter

    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The value of the query field, for example, string in ?q=string.
    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.
    escapeValue boolean
    Matches when the value is URL-escaped.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName string
    The name of the query field, for example, q in ?q=string.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The value of the query field, for example, string in ?q=string.
    escape_value bool
    Matches when the value is URL-escaped.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the parameterName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameter_name str
    The name of the query field, for example, q in ?q=string.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.

    GetPropertyRulesBuilderRulesV20230530CriterionRandom

    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket Integer
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    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.
    bucket Number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionRecoveryConfig

    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    config_name str
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked bool
    Indicates that your 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.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionRegularExpression

    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive boolean
    Sets a case-sensitive regular expression 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.
    matchString string
    The string to match, typically the contents of a dynamic variable.
    regex string
    The regular expression (PCRE) to match against the string.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    case_sensitive bool
    Sets a case-sensitive regular expression 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_string str
    The string to match, typically the contents of a dynamic variable.
    regex str
    The regular expression (PCRE) to match against the string.
    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.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionRequestCookie

    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookie_name str
    The name of the cookie, for example, visitor in visitor:anon.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the cookieName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.

    GetPropertyRulesBuilderRulesV20230530CriterionRequestHeader

    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName string
    The name of the request header, for example Accept-Language.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    header_name str
    The name of the request header, for example Accept-Language.
    locked bool
    Indicates 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_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more 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.
    values Sequence[str]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.

    GetPropertyRulesBuilderRulesV20230530CriterionRequestMethod

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked bool
    Indicates 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_operator str
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.

    GetPropertyRulesBuilderRulesV20230530CriterionRequestProtocol

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked bool
    Indicates that your 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.

    GetPropertyRulesBuilderRulesV20230530CriterionRequestType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked bool
    Indicates 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_operator str
    Specifies whether the request IS or IS_NOT the type of specified 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.
    value str
    Specifies the type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.

    GetPropertyRulesBuilderRulesV20230530CriterionResponseHeader

    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName string
    The name of the response header, for example Content-Type.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator string
    Narrows the match according to various criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    header_name str
    The name of the response header, for example Content-Type.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_value bool
    When enabled, the match is case-sensitive for the value field.
    match_operator str
    Narrows the match according to various criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.

    GetPropertyRulesBuilderRulesV20230530CriterionServerLocation

    Continents List<string>
    Continent codes.
    Countries List<string>
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Continents []string
    Continent codes.
    Countries []string
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents string[]
    Continent codes.
    countries string[]
    ISO 3166-1 country codes, such as US or CN.
    locationType string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents Sequence[str]
    Continent codes.
    countries Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    location_type str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    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.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionTime

    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate string
    Sets the start of a time period.
    endDate string
    Sets the end of a fixed time period.
    lastingDate string
    Sets the start of a fixed time period.
    lastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies how to define the range of time.
    repeatBeginDate string
    Sets the start of the initial time period.
    repeatDuration string
    Sets the duration of each repeating time period.
    repeatInterval string
    Sets the time between each repeating time period's starting points.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    apply_daylight_savings_time bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    begin_date str
    Sets the start of a time period.
    end_date str
    Sets the end of a fixed time period.
    lasting_date str
    Sets the start of a fixed time period.
    lasting_duration str
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked bool
    Indicates 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_operator str
    Specifies how to define the range of time.
    repeat_begin_date str
    Sets the start of the initial time period.
    repeat_duration str
    Sets the duration of each repeating time period.
    repeat_interval str
    Sets the time between each repeating time period's starting points.
    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.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionTokenAuthorization

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Error match scope.
    StatusLists List<string>
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Error match scope.
    StatusLists []string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Error match scope.
    statusLists string[]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Error match scope.
    status_lists Sequence[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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionUserAgent

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    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.
    values Sequence[str]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).

    GetPropertyRulesBuilderRulesV20230530CriterionUserLocation

    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues List<string>
    Continent codes.
    CountryValues List<string>
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues []string
    Continent codes.
    CountryValues []string
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps string
    Specifies which IP addresses determine the user's location.
    continentValues string[]
    Continent codes.
    countryValues string[]
    ISO 3166-1 country codes, such as US or CN.
    field string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    check_ips str
    Specifies which IP addresses determine the user's location.
    continent_values Sequence[str]
    Continent codes.
    country_values Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    field str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    region_values Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionUserNetwork

    BandwidthValues List<string>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues List<string>
    NetworkValues List<string>
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BandwidthValues []string
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues []string
    NetworkValues []string
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues string[]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps string
    Specifies which IP addresses determine the user's network.
    field string
    The type of information 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.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues string[]
    networkValues string[]
    Any set of specific networks.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidth_values Sequence[str]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    check_ips str
    Specifies which IP addresses determine the user's network.
    field str
    The type of information 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    network_type_values Sequence[str]
    network_values Sequence[str]
    Any set of specific networks.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionVariableError

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames List<string>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames []string
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames string[]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    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_names Sequence[str]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.

    GetPropertyRulesBuilderRulesV20230530CriterionVirtualWaitingRoomRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CriterionVisitorPrioritizationRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230530CustomOverride

    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override
    name string
    The name of a custom override
    overrideId string
    The ID of a custom override
    name str
    The name of a custom override
    override_id str
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override

    GetPropertyRulesBuilderRulesV20230530Variable

    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable
    description string
    The description for a variable
    hidden boolean
    Whether a variable should be hidden
    name string
    The name of a variable
    sensitive boolean
    States whether a variable contains sensitive information
    value string
    The value for a variable
    description str
    The description for a variable
    hidden bool
    Whether a variable should be hidden
    name str
    The name of a variable
    sensitive bool
    States whether a variable contains sensitive information
    value str
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable

    GetPropertyRulesBuilderRulesV20230920

    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors List<GetPropertyRulesBuilderRulesV20230920Behavior>
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions List<GetPropertyRulesBuilderRulesV20230920Criterion>
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20230920CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables List<GetPropertyRulesBuilderRulesV20230920Variable>
    A list of variables for a rule
    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors []GetPropertyRulesBuilderRulesV20230920Behavior
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions []GetPropertyRulesBuilderRulesV20230920Criterion
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20230920CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables []GetPropertyRulesBuilderRulesV20230920Variable
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride String
    XML metadata of the rule
    behaviors List<GetPropertyRulesBuilderRulesV20230920Behavior>
    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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<GetPropertyRulesBuilderRulesV20230920Criterion>
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20230920CustomOverride
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid String
    The UUID of a rule template
    uuid String
    The UUID of the rule
    variables List<GetPropertyRulesBuilderRulesV20230920Variable>
    A list of variables for a rule
    name string
    The name of a rule
    advancedOverride string
    XML metadata of the rule
    behaviors GetPropertyRulesBuilderRulesV20230920Behavior[]
    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
    criteriaLocked boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    criterions GetPropertyRulesBuilderRulesV20230920Criterion[]
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20230920CustomOverride
    XML metadata of the rule
    isSecure boolean
    States whether a rule is secure
    templateLink string
    The template link for the rule
    templateUuid string
    The UUID of a rule template
    uuid string
    The UUID of the rule
    variables GetPropertyRulesBuilderRulesV20230920Variable[]
    A list of variables for a rule
    name str
    The name of a rule
    advanced_override str
    XML metadata of the rule
    behaviors Sequence[GetPropertyRulesBuilderRulesV20230920Behavior]
    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_satisfy str
    States whether 'all' criteria need to match or 'any'
    criterions Sequence[GetPropertyRulesBuilderRulesV20230920Criterion]
    The list of criteria for a rule
    custom_override GetPropertyRulesBuilderRulesV20230920CustomOverride
    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[GetPropertyRulesBuilderRulesV20230920Variable]
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride 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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<Property Map>
    The list of criteria for a rule
    customOverride Property Map
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid 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

    GetPropertyRulesBuilderRulesV20230920Behavior

    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230920BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20230920BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20230920BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230920BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20230920BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20230920BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20230920BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20230920BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20230920BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20230920BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20230920BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20230920BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20230920BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20230920BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20230920BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20230920BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20230920BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20230920BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20230920BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20230920BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20230920BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20230920BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20230920BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20230920BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230920BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20230920BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20230920BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20230920BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20230920BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20230920BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20230920BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20230920BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20230920BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20230920BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20230920BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20230920BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20230920BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20230920BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230920BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20230920BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20230920BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20230920BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20230920BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20230920BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20230920BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20230920BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20230920BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20230920BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20230920BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20230920BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20230920BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20230920BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20230920BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20230920BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230920BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20230920BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20230920BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20230920BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20230920BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20230920BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20230920BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20230920BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20230920BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20230920BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230920BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230920BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20230920BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20230920BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20230920BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20230920BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20230920BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20230920BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20230920BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20230920BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20230920BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20230920BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230920BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20230920BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230920BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20230920BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20230920BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20230920BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230920BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20230920BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230920BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20230920BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20230920BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20230920BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20230920BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20230920BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230920BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20230920BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20230920BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20230920BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20230920BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20230920BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20230920BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20230920BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20230920BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20230920BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20230920BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20230920BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20230920BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20230920BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20230920BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20230920BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20230920BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20230920BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20230920BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20230920BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20230920BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20230920BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20230920BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20230920BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20230920BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20230920BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20230920BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20230920BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20230920BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20230920BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20230920BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20230920BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20230920BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20230920BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20230920BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20230920BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20230920BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20230920BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20230920BehaviorWebdav
    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.
    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230920BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20230920BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20230920BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230920BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20230920BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20230920BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20230920BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20230920BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20230920BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20230920BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20230920BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20230920BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20230920BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20230920BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20230920BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20230920BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20230920BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20230920BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20230920BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20230920BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20230920BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20230920BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20230920BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20230920BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230920BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20230920BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20230920BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20230920BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20230920BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20230920BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20230920BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20230920BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20230920BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20230920BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20230920BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20230920BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20230920BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20230920BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230920BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20230920BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20230920BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20230920BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20230920BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20230920BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20230920BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20230920BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20230920BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20230920BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20230920BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20230920BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20230920BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20230920BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20230920BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20230920BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230920BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20230920BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20230920BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20230920BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20230920BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20230920BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20230920BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20230920BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20230920BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20230920BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230920BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230920BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20230920BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20230920BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20230920BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20230920BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20230920BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20230920BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20230920BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20230920BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20230920BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20230920BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230920BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20230920BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230920BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20230920BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20230920BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20230920BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230920BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20230920BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230920BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20230920BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20230920BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20230920BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20230920BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20230920BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230920BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20230920BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20230920BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20230920BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20230920BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20230920BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20230920BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20230920BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20230920BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20230920BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20230920BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20230920BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20230920BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20230920BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20230920BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20230920BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20230920BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20230920BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20230920BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20230920BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20230920BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20230920BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20230920BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20230920BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20230920BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20230920BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20230920BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20230920BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20230920BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20230920BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20230920BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20230920BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20230920BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20230920BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20230920BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20230920BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20230920BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20230920BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20230920BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230920BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230920BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20230920BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230920BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20230920BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20230920BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20230920BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20230920BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20230920BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20230920BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20230920BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20230920BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20230920BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20230920BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20230920BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230920BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20230920BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230920BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20230920BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20230920BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20230920BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20230920BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20230920BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20230920BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230920BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20230920BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20230920BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20230920BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20230920BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20230920BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20230920BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20230920BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20230920BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20230920BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20230920BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20230920BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230920BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230920BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230920BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20230920BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20230920BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20230920BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20230920BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20230920BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20230920BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20230920BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20230920BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20230920BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20230920BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20230920BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20230920BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20230920BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20230920BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20230920BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230920BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20230920BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20230920BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20230920BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230920BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20230920BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20230920BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20230920BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20230920BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20230920BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230920BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230920BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20230920BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20230920BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230920BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20230920BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20230920BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20230920BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20230920BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20230920BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20230920BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20230920BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230920BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20230920BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230920BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20230920BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20230920BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20230920BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230920BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20230920BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230920BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20230920BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230920BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20230920BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20230920BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20230920BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230920BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20230920BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20230920BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230920BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20230920BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20230920BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20230920BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230920BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230920BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20230920BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20230920BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20230920BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230920BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20230920BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20230920BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20230920BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20230920BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20230920BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20230920BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20230920BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20230920BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20230920BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20230920BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20230920BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20230920BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20230920BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20230920BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20230920BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20230920BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20230920BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20230920BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20230920BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20230920BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20230920BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230920BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20230920BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230920BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20230920BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230920BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20230920BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230920BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20230920BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20230920BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20230920BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20230920BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20230920BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20230920BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20230920BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20230920BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20230920BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20230920BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20230920BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20230920BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20230920BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230920BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20230920BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230920BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20230920BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20230920BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20230920BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20230920BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20230920BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20230920BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230920BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20230920BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20230920BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20230920BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20230920BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20230920BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20230920BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20230920BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20230920BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20230920BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20230920BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20230920BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230920BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230920BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20230920BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20230920BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20230920BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20230920BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20230920BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20230920BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20230920BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20230920BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20230920BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20230920BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20230920BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20230920BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20230920BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20230920BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20230920BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20230920BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20230920BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20230920BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20230920BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20230920BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20230920BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230920BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20230920BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20230920BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20230920BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20230920BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20230920BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20230920BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20230920BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20230920BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20230920BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230920BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20230920BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20230920BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20230920BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20230920BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20230920BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20230920BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20230920BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20230920BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20230920BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20230920BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20230920BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20230920BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20230920BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20230920BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20230920BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230920BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20230920BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20230920BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20230920BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230920BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20230920BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20230920BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20230920BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230920BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20230920BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20230920BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230920BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20230920BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20230920BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20230920BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230920BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230920BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20230920BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20230920BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20230920BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230920BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20230920BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20230920BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20230920BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20230920BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20230920BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20230920BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20230920BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20230920BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20230920BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20230920BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20230920BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20230920BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20230920BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20230920BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20230920BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20230920BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20230920BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20230920BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20230920BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20230920BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20230920BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230920BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20230920BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20230920BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230920BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20230920BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230920BehaviorWebdav
    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_circuit_breaker GetPropertyRulesBuilderRulesV20230920BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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 GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptive_image_compression GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20230920BehaviorAdvanced
    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 GetPropertyRulesBuilderRulesV20230920BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizer_tag GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizerTag
    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_in_cache_hierarchy GetPropertyRulesBuilderRulesV20230920BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allow_cloudlets_origins GetPropertyRulesBuilderRulesV20230920BehaviorAllowCloudletsOrigins
    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 GetPropertyRulesBuilderRulesV20230920BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_https_cache_key_sharing GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allow_https_downgrade GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsDowngrade
    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 GetPropertyRulesBuilderRulesV20230920BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allow_patch GetPropertyRulesBuilderRulesV20230920BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_post GetPropertyRulesBuilderRulesV20230920BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_put GetPropertyRulesBuilderRulesV20230920BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allow_transfer_encoding GetPropertyRulesBuilderRulesV20230920BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    alt_svc_header GetPropertyRulesBuilderRulesV20230920BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    api_prioritization GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    application_load_balancer GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancer
    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 GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentation
    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_validation GetPropertyRulesBuilderRulesV20230920BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    base_directory GetPropertyRulesBuilderRulesV20230920BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    boss_beaconing GetPropertyRulesBuilderRulesV20230920BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20230920BehaviorBreadcrumbs
    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 GetPropertyRulesBuilderRulesV20230920BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20230920BehaviorBrotli
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cache_id GetPropertyRulesBuilderRulesV20230920BehaviorCacheId
    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_ignore_case GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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_query_params GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyQueryParams
    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_rewrite GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyRewrite
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCachePost
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCacheRedirect
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCacheTag
    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. The cacheTag 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_visible GetPropertyRulesBuilderRulesV20230920BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20230920BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    central_authorization GetPropertyRulesBuilderRulesV20230920BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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 GetPropertyRulesBuilderRulesV20230920BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    client_certificate_auth GetPropertyRulesBuilderRulesV20230920BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    client_characteristics GetPropertyRulesBuilderRulesV20230920BehaviorClientCharacteristics
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCloudInterconnects
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloud_wrapper_advanced GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapperAdvanced
    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.
    common_media_client_data GetPropertyRulesBuilderRulesV20230920BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditional_origin GetPropertyRulesBuilderRulesV20230920BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    construct_response GetPropertyRulesBuilderRulesV20230920BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    content_characteristics GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristics
    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_amd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsAmd
    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_dd GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsDd
    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_wsd_large_file GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLargeFile
    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_wsd_live GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLive
    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_wsd_vod GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdVod
    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_position GetPropertyRulesBuilderRulesV20230920BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    content_targeting_protection GetPropertyRulesBuilderRulesV20230920BehaviorContentTargetingProtection
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCorsSupport
    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 GetPropertyRulesBuilderRulesV20230920BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    custom_behavior GetPropertyRulesBuilderRulesV20230920BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20230920BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20230920BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcp_auth_hmac_transformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_regex_transformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_substring_transformation GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_variable_extractor GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthVariableExtractor
    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_authz_groups GetPropertyRulesBuilderRulesV20230920BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcp_dev_relations GetPropertyRulesBuilderRulesV20230920BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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_time_auth GetPropertyRulesBuilderRulesV20230920BehaviorDcpRealTimeAuth
    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 GetPropertyRulesBuilderRulesV20230920BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    deny_access GetPropertyRulesBuilderRulesV20230920BehaviorDenyAccess
    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_failover_access GetPropertyRulesBuilderRulesV20230920BehaviorDenyDirectFailoverAccess
    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_cache_id GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicCacheId
    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_header GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dns_async_refresh GetPropertyRulesBuilderRulesV20230920BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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 GetPropertyRulesBuilderRulesV20230920BehaviorDnsPrefresh
    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 GetPropertyRulesBuilderRulesV20230920BehaviorDowngradeProtocol
    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_marker GetPropertyRulesBuilderRulesV20230920BehaviorDownloadCompleteMarker
    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 GetPropertyRulesBuilderRulesV20230920BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstream_cache GetPropertyRulesBuilderRulesV20230920BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamic_throughtput_optimization GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimization
    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_optimization_override GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimizationOverride
    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_content GetPropertyRulesBuilderRulesV20230920BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecms_bulk_upload GetPropertyRulesBuilderRulesV20230920BehaviorEcmsBulkUpload
    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 GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecms_dataset GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDataset
    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_key GetPropertyRulesBuilderRulesV20230920BehaviorEcmsObjectKey
    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 GetPropertyRulesBuilderRulesV20230920BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edge_load_balancing_advanced GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingAdvanced
    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_balancing_data_center GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenter
    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_balancing_origin GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingOrigin
    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.
    edge_origin_authorization GetPropertyRulesBuilderRulesV20230920BehaviorEdgeOriginAuthorization
    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 GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edge_scape GetPropertyRulesBuilderRulesV20230920BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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_includes GetPropertyRulesBuilderRulesV20230920BehaviorEdgeSideIncludes
    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, or filename. 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 GetPropertyRulesBuilderRulesV20230920BehaviorEdgeWorker
    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.
    enforce_mtls_settings GetPropertyRulesBuilderRulesV20230920BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhanced_akamai_protocol GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedAkamaiProtocol
    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_detection GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedProxyDetection
    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_header_enrichment GetPropertyRulesBuilderRulesV20230920BehaviorEpdForwardHeaderEnrichment
    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 GetPropertyRulesBuilderRulesV20230920BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failover_bot_manager_feature_compatibility GetPropertyRulesBuilderRulesV20230920BehaviorFailoverBotManagerFeatureCompatibility
    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 GetPropertyRulesBuilderRulesV20230920BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20230920BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    first_party_marketing GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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_marketing_plus GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing 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 GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20230920BehaviorG2oheader
    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_number GetPropertyRulesBuilderRulesV20230920BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphql_caching GetPropertyRulesBuilderRulesV20230920BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzip_response GetPropertyRulesBuilderRulesV20230920BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hd_data_advanced GetPropertyRulesBuilderRulesV20230920BehaviorHdDataAdvanced
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHealthDetection
    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_binding GetPropertyRulesBuilderRulesV20230920BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20230920BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    http_strict_transport_security GetPropertyRulesBuilderRulesV20230920BehaviorHttpStrictTransportSecurity
    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_https_upgrade GetPropertyRulesBuilderRulesV20230920BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    im_override GetPropertyRulesBuilderRulesV20230920BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    image_and_video_manager GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManager
    This behavior can be used in includes.
    image_manager GetPropertyRulesBuilderRulesV20230920BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    image_manager_video GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20230920BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20230920BehaviorInstant
    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 GetPropertyRulesBuilderRulesV20230920BehaviorInstantConfig
    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_optimization GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    large_file_optimization_advanced GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limit_bit_rate GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    log_custom GetPropertyRulesBuilderRulesV20230920BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    m_pulse GetPropertyRulesBuilderRulesV20230920BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifest_personalization GetPropertyRulesBuilderRulesV20230920BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifest_rerouting GetPropertyRulesBuilderRulesV20230920BehaviorManifestRerouting
    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_push GetPropertyRulesBuilderRulesV20230920BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    media_acceleration GetPropertyRulesBuilderRulesV20230920BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    media_acceleration_quic_optout GetPropertyRulesBuilderRulesV20230920BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    media_client GetPropertyRulesBuilderRulesV20230920BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    media_file_retrieval_optimization GetPropertyRulesBuilderRulesV20230920BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    media_origin_failover GetPropertyRulesBuilderRulesV20230920BehaviorMediaOriginFailover
    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 GetPropertyRulesBuilderRulesV20230920BehaviorMetadataCaching
    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_performance GetPropertyRulesBuilderRulesV20230920BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modify_incoming_request_header GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modify_incoming_response_header GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modify_outgoing_request_header GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modify_outgoing_response_header GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modify_via_header GetPropertyRulesBuilderRulesV20230920BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20230920BehaviorOrigin
    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 GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristics
    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_wsd GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    origin_failure_recovery_method GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    origin_failure_recovery_policy GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    origin_ip_acl GetPropertyRulesBuilderRulesV20230920BehaviorOriginIpAcl
    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.
    permissions_policy GetPropertyRulesBuilderRulesV20230920BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistent_client_connection GetPropertyRulesBuilderRulesV20230920BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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 GetPropertyRulesBuilderRulesV20230920BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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_information GetPropertyRulesBuilderRulesV20230920BehaviorPersonallyIdentifiableInformation
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20230920BehaviorPreconnect
    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_delivery GetPropertyRulesBuilderRulesV20230920BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictive_prefetching GetPropertyRulesBuilderRulesV20230920BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20230920BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefresh_cache GetPropertyRulesBuilderRulesV20230920BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20230920BehaviorQuality
    This behavior can be used in includes.
    quic_beta GetPropertyRulesBuilderRulesV20230920BehaviorQuicBeta
    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 GetPropertyRulesBuilderRulesV20230920BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20230920BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    read_timeout GetPropertyRulesBuilderRulesV20230920BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    real_time_reporting GetPropertyRulesBuilderRulesV20230920BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    real_user_monitoring GetPropertyRulesBuilderRulesV20230920BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20230920BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20230920BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    referer_checking GetPropertyRulesBuilderRulesV20230920BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    remove_query_parameter GetPropertyRulesBuilderRulesV20230920BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    remove_vary GetPropertyRulesBuilderRulesV20230920BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20230920BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    request_client_hints GetPropertyRulesBuilderRulesV20230920BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    request_control GetPropertyRulesBuilderRulesV20230920BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    request_type_marker GetPropertyRulesBuilderRulesV20230920BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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 GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resource_optimizer_extended_compatibility GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizerExtendedCompatibility
    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 GetPropertyRulesBuilderRulesV20230920BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    response_cookie GetPropertyRulesBuilderRulesV20230920BehaviorResponseCookie
    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_caching GetPropertyRulesBuilderRulesV20230920BehaviorRestrictObjectCaching
    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_status GetPropertyRulesBuilderRulesV20230920BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewrite_url GetPropertyRulesBuilderRulesV20230920BehaviorRewriteUrl
    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 GetPropertyRulesBuilderRulesV20230920BehaviorRumCustom
    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 GetPropertyRulesBuilderRulesV20230920BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    sales_force_commerce_cloud_client GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudClient
    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_commerce_cloud_provider GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    sales_force_commerce_cloud_provider_host_header GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    save_post_dca_processing GetPropertyRulesBuilderRulesV20230920BehaviorSavePostDcaProcessing
    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 GetPropertyRulesBuilderRulesV20230920BehaviorScheduleInvalidation
    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 GetPropertyRulesBuilderRulesV20230920BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmented_content_protection GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmented_media_optimization GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmented_media_streaming_prefetch GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaStreamingPrefetch
    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 GetPropertyRulesBuilderRulesV20230920BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulate_error_code GetPropertyRulesBuilderRulesV20230920BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    site_shield GetPropertyRulesBuilderRulesV20230920BehaviorSiteShield
    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_migration GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standard_tls_migration_override GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigrationOverride
    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_parsing GetPropertyRulesBuilderRulesV20230920BehaviorStrictHeaderParsing
    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 GetPropertyRulesBuilderRulesV20230920BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sure_route GetPropertyRulesBuilderRulesV20230920BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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 GetPropertyRulesBuilderRulesV20230920BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    tea_leaf GetPropertyRulesBuilderRulesV20230920BehaviorTeaLeaf
    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 GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistribution
    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 the cache 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_advanced GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tiered_distribution_customization GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20230920BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uid_configuration GetPropertyRulesBuilderRulesV20230920BehaviorUidConfiguration
    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_tag GetPropertyRulesBuilderRulesV20230920BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verify_json_web_token GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verify_json_web_token_for_dcp GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verify_token_authorization GetPropertyRulesBuilderRulesV20230920BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtual_waiting_room GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtual_waiting_room_with_edge_workers GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoomWithEdgeWorkers
    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 GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo_standalone GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20230920BehaviorWatermarking
    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_firewall GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewall
    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 GetPropertyRulesBuilderRulesV20230920BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20230920BehaviorWebdav
    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.
    adScalerCircuitBreaker Property Map
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration 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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression Property Map
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. 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.
    aggregatedReporting Property Map
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. 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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag 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.
    allHttpInCacheHierarchy Property Map
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins Property Map
    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.
    allowDelete 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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing Property Map
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade Property Map
    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.
    allowOptions 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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch 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, and allowPut behaviors. This behavior can be used in includes.
    allowPost 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, and allowPut behaviors. This behavior can be used in includes.
    allowPut 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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding Property Map
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader Property Map
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization 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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer Property Map
    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.
    audienceSegmentation 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.
    autoDomainValidation Property Map
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory Property Map
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing 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.
    breadcrumbs 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.
    breakConnection 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.
    cacheError 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, and 505. This behavior can be used in includes.
    cacheId 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.
    cacheKeyIgnoreCase Property Map
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams Property Map
    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.
    cacheKeyRewrite Property Map
    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.
    cachePost 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.
    cacheRedirect 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.
    cacheTag 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. The cacheTag 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.
    cacheTagVisible Property Map
    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 the modifyOutgoingResponseHeader 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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization 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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects Property Map
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth Property Map
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics 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.
    cloudInterconnects 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.
    cloudWrapper 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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced Property Map
    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.
    commonMediaClientData Property Map
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin Property Map
    This behavior cannot be used in includes.
    constructResponse 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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics 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.
    contentCharacteristicsAmd 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.
    contentCharacteristicsDd 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.
    contentCharacteristicsWsdLargeFile Property Map
    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.
    contentCharacteristicsWsdLive Property Map
    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.
    contentCharacteristicsWsdVod Property Map
    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.
    contentPrePosition Property Map
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection Property Map
    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.
    corsSupport 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.
    cpCode 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 the List CP codes operation. This behavior can be used in includes.
    customBehavior 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 relevant behaviorId value from the response within the current customBehavior. See Custom 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 the DataStream 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. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor Property Map
    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.
    dcpDefaultAuthzGroups Property Map
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations Property Map
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth Property Map
    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.
    deliveryReceipt 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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess 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.
    denyDirectFailoverAccess Property Map
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId Property Map
    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.
    deviceCharacteristicHeader Property Map
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh Property Map
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh 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.
    downgradeProtocol 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.
    downloadCompleteMarker 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 logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes.
    downloadNotification 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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache 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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization Property Map
    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.
    dynamicThroughtputOptimizationOverride Property Map
    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.
    dynamicWebContent Property Map
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload Property Map
    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.
    ecmsDatabase 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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset 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.
    ecmsObjectKey Property Map
    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.
    edgeConnect Property Map
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced Property Map
    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.
    edgeLoadBalancingDataCenter Property Map
    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.
    edgeLoadBalancingOrigin Property Map
    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.
    edgeOriginAuthorization 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.
    edgeRedirector Property Map
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape 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 special X-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.
    edgeSideIncludes Property Map
    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, or filename. 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.
    edgeWorker 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.
    enforceMtlsSettings Property Map
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol Property Map
    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.
    enhancedProxyDetection Property Map
    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.
    epdForwardHeaderEnrichment Property Map
    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.
    failAction 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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility Property Map
    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.
    fastInvalidate Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips Property Map
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing Property Map
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus Property Map
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite 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 within Control Center, or use the Cloudlets API to configure it programmatically. 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.
    globalRequestNumber Property Map
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching Property Map
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse 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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced Property Map
    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.
    healthDetection 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.
    hsafEipBinding Property Map
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity Property Map
    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.
    httpToHttpsUpgrade Property Map
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride 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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager Property Map
    This behavior can be used in includes.
    imageManager 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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo Property Map
    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 a fileExtension. 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.
    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.
    instantConfig 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.
    largeFileOptimization Property Map
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced Property Map
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate Property Map
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom Property Map
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse Property Map
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization 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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting 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.
    manualServerPush Property Map
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration Property Map
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout Property Map
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization Property Map
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover Property Map
    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.
    metadataCaching 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.
    mobileSdkPerformance Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader Property Map
    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.
    originCharacteristics 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.
    originCharacteristicsWsd Property Map
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod Property Map
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy Property Map
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl Property Map
    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.
    permissionsPolicy Property Map
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection Property Map
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection Property Map
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation Property Map
    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.
    phasedRelease 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 within Control 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.
    predictiveContentDelivery Property Map
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching 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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache 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.
    quicBeta 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.
    randomSeek 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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout 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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting Property Map
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring Property Map
    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 on destinationHostname and destinationPath 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 use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking Property Map
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter Property Map
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary Property Map
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary 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.
    requestClientHints Property Map
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker Property Map
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility Property Map
    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.
    responseCode 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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie 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.
    restrictObjectCaching Property Map
    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.
    returnCacheStatus Property Map
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl 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.
    rumCustom 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.
    saasDefinitions Property Map
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient Property Map
    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.
    salesForceCommerceCloudProvider Property Map
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader Property Map
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing Property Map
    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.
    scheduleInvalidation 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.
    scriptManagement Property Map
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection Property Map
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization Property Map
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch Property Map
    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.
    setVariable 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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode Property Map
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield 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.
    standardTlsMigration Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride 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.
    strictHeaderParsing Property Map
    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.
    subCustomer 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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute Property Map
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf 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.
    tieredDistribution 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 the cache 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.
    tieredDistributionAdvanced 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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization Property Map
    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 enable cloudWrapper 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.
    uidConfiguration 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.
    validateEntityTag Property Map
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken Property Map
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp Property Map
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization Property Map
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom Property Map
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers Property Map
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization Property Map
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo Property Map
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone Property Map
    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.
    webApplicationFirewall Property Map
    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.
    webSockets 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorAdScalerCircuitBreaker

    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased string
    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.
    responseCodeBased boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased string
    Defines a custom error response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response_code_based str
    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_based bool
    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, or SPECIFY_YOUR_OWN for a custom code.
    response_delay_based bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    response_delay_threshold str
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    return_error_response_code_based str
    Specifies the error to include in the response to the client.
    specify_your_own_response_code_based str
    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.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveAcceleration

    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid string
    This option is for internal usage only.
    titleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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. See Add 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.
    cookie_name str
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enable_brotli_compression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enable_for_noncacheable bool
    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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring 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_server_push str
    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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorAdaptiveImageCompression

    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Integer
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Integer
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Integer
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Integer
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Integer
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Integer
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    compressMobile boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid string
    This option is for internal usage only.
    tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    tier1MobileCompressionValue number
    Specifies the compression percentage.
    tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue number
    Specifies the compression percentage.
    tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue number
    Specifies the compression percentage.
    tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue number
    Specifies the compression percentage.
    tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue number
    Specifies the compression percentage.
    tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue number
    Specifies the compression percentage.
    titleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    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_compression_method str
    Specifies tier-1 behavior.
    tier1_mobile_compression_value int
    Specifies the compression percentage.
    tier1_standard_compression_method str
    Specifies tier-1 non-cellular network behavior.
    tier1_standard_compression_value int
    Specifies the compression percentage.
    tier2_mobile_compression_method str
    Specifies tier-2 cellular-network behavior.
    tier2_mobile_compression_value int
    Specifies the compression percentage.
    tier2_standard_compression_method str
    Specifies tier-2 non-cellular network behavior.
    tier2_standard_compression_value int
    Specifies the compression percentage.
    tier3_mobile_compression_method str
    Specifies tier-3 cellular-network behavior.
    tier3_mobile_compression_value int
    Specifies the compression percentage.
    tier3_standard_compression_method str
    Specifies tier-3 non-cellular network behavior.
    tier3_standard_compression_value int
    Specifies the compression percentage.
    title_aic_mobile str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    title_aic_nonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Number
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Number
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Number
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Number
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Number
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Number
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorAggregatedReporting

    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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizer

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAkamaizerTag

    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname string
    Specifies the replacement hostname for the tag to use.
    scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    include_tags_attribute 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.
    tags_attribute 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.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllHttpInCacheHierarchy

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowCloudletsOrigins

    Enabled bool
    Allows you to assign custom origin definitions referenced in sub-rules by cloudletsOrigin labels. If disabled, all sub-rules are ignored.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory boolean
    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.
    purgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_directory bool
    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_query_parameter str
    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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowDelete

    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsCacheKeySharing

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowHttpsDowngrade

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowOptions

    Enabled bool
    Set this to true to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowPatch

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowPost

    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled boolean
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_content_length bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled 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.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowPut

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAllowTransferEncoding

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAltSvcHeader

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge Integer
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the Alt-Svc header. The default max-age for an Alt-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.
    maxAge Number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritization

    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    alternateResponseCacheTtl Integer
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Integer
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.
    alternateResponseCacheTtl number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid string
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode boolean
    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_cache_ttl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled bool
    Activates the API Prioritization feature.
    is_shared_policy 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.
    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 GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    net_storage_path str
    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_code GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttled_status_code int
    Specifies the HTTP response code for requests that receive the alternate response.
    use_throttled_cp_code bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    use_throttled_status_code bool
    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.
    alternateResponseCacheTtl Number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage Property Map
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode Property Map
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.

    GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancer

    AllDownNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps List<GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes List<string>
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllDownNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps []GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerFailoverOriginMap
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes []string
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Integer
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode string
    Determines what to do if an origin fails.
    failoverOriginMaps GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerFailoverOriginMap[]
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes string[]
    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.
    failoverTitle 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.
    originCookieName string
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration string
    Sets how long it is before the cookie expires.
    stickinessExpirationDate string
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_net_storage GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    all_down_net_storage_file str
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    all_down_status_code str
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    all_down_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_cache_prefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cached_content_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Activates the Application Load Balancer Cloudlet.
    failover_attempts_threshold int
    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_maps Sequence[GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerFailoverOriginMap]
    Specifies a fixed set of failover mapping rules.
    failover_status_codes Sequence[str]
    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.
    origin_cookie_name str
    Specifies the name for your session cookie.
    specify_stickiness_cookie_domain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickiness_cookie_automatic_salt 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.
    stickiness_cookie_domain str
    Specifies the domain to track the stickiness cookie.
    stickiness_cookie_salt str
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickiness_cookie_set_http_only_flag bool
    Ensures the cookie is transmitted only over HTTP.
    stickiness_cookie_type 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_date str
    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.
    allDownNetStorage Property Map
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<Property Map>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerAllDownNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorApplicationLoadBalancerFailoverOriginMap

    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds List<string>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds []string
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds string[]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    from_origin_id str
    Specifies the origin whose failure triggers the mapping rule.
    to_origin_ids Sequence[str]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.

    GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentation

    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain string
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType string
    Specifies when the segmentation cookie expires.
    populationDuration string
    Specifies the lifetime of the segmentation cookie.
    populationRefresh boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    population_cookie_automatic_salt 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.
    population_cookie_domain str
    Specifies the domain to track the population cookie.
    population_cookie_include_rule_name bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    population_cookie_salt str
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    population_cookie_type 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.
    segment_tracking_cookie_name str
    This cookie name specifies the name of the segmentation rule.
    segment_tracking_custom_header str
    This custom HTTP header specifies the name of the segmentation rule.
    segment_tracking_method str
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segment_tracking_query_param str
    This query parameter specifies the name of the segmentation rule.
    segment_tracking_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specify_population_cookie_domain 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorAudienceSegmentationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorAutoDomainValidation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorBaseDirectory

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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/.

    GetPropertyRulesBuilderRulesV20230920BehaviorBossBeaconing

    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses List<string>
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses []string
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern string
    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.
    conditionalHttpStatuses string[]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency string
    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.
    forwardType 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.
    requestType string
    Specify when to trigger a beacon.
    samplingFrequency string
    Specifies a sampling frequency or disables beacons.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_pattern str
    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_statuses Sequence[str]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditional_sampling_frequency str
    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.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorBreadcrumbs

    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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 opposite ak-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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorBreakConnection

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorBrotli

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheError

    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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and 504 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 to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheId

    Elements List<string>
    Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    Specifies the name of the variable you want to include in the cache key.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyIgnoreCase

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyQueryParams

    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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheKeyRewrite

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey string
    Specifies the new cache key path as an alphanumeric value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCachePost

    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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    templateUuid string
    This option is for internal usage only.
    useBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheRedirect

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheTag

    Locked bool
    Indicates 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCacheTagVisible

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCaching

    Behavior string
    Specify the caching option.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    cacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl string
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache boolean
    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 live ttl to zero seconds.
    honorNoStore boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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_directives str
    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_support bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-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_age bool
    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 the max-age directive and the defaultTtl setting.
    honor_must_revalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honor_no_cache bool
    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 live ttl to zero seconds.
    honor_no_store bool
    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_revalidate bool
    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_maxage 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 the max-age directive and the defaultTtl 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.

    GetPropertyRulesBuilderRulesV20230920BehaviorCentralAuthorization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorChaseRedirects

    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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorClientCertificateAuth

    ClientCertificateAttributes List<string>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ClientCertificateAttributes []string
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes string[]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    client_certificate_attributes Sequence[str]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enable_client_certificate_validation_status bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enable_complete_client_certificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked bool
    Indicates that your 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.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorClientCharacteristics

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCloudInterconnects

    CloudLocations 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudLocations []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapper

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCloudWrapperAdvanced

    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_map str
    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.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCommonMediaClientData

    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_cmcd_segment_prefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked bool
    Indicates that your 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.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorConditionalOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorConstructResponse

    Body string
    HTML response of up to 2000 characters to send to the end-user client.
    Enabled bool
    Serves the custom response.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Integer
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode number
    The HTTP response code to send to the end-user client.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Number
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristics

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsAmd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom double
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom double
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom float64
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom float64
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Integer
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Integer
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Double
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Double
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationDashCustom number
    Customizes the number of seconds for the segment.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom number
    Customizes the number of seconds for the fragment.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationHlsCustom number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom number
    Customizes the number of seconds for the fragment.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_dash_custom int
    Customizes the number of seconds for the segment.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hds_custom int
    Customizes the number of seconds for the fragment.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_hls_custom float
    Customizes the number of seconds for the segment.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_duration_smooth_custom float
    Customizes the number of seconds for the fragment.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Number
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Number
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsDd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLargeFile

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdLive

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentCharacteristicsWsdVod

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentPrePosition

    Enabled bool
    Enables the Content PrePosition behavior.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation string
    sourceType string
    targets string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorContentTargetingProtection

    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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains List<string>
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses []string
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses []string
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains []string
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled boolean
    Enables the Content Targeting feature.
    geoProtectionMode string
    Specifies how to handle requests.
    geoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses string[]
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode string
    Specifies how to handle requests.
    ipProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl string
    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.
    overrideIpAddresses string[]
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains string[]
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode string
    Specify the action to take.
    referrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_protection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enable_geo_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_ip_protection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enable_ip_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_referrer_protection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enable_referrer_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enabled bool
    Enables the Content Targeting feature.
    geo_protection_mode str
    Specifies how to handle requests.
    geo_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geo_redirect_url str
    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_mode str
    Specifies how to handle requests.
    ip_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ip_redirect_url str
    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_addresses Sequence[str]
    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_mode str
    Specify the action to take.
    referrer_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrer_redirect_url str
    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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCorsSupport

    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders []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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflight_max_age str
    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.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorCustomBehavior

    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDatastream

    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames List<string>
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames []string
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Integer
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled boolean
    Enables 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.
    logEnabled boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames string[]
    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.
    logStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage number
    Specifies the percentage of log data you want to collect for this property.
    streamType string
    Specify the DataStream type.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collect_midgress_traffic bool
    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_names Sequence[str]
    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_title str
    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.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Number
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcp

    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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.
    namespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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 the IoT 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthHmacTransformation

    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm string
    Specifies the hash algorithm.
    hashConversionKey string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_algorithm str
    Specifies the hash algorithm.
    hash_conversion_key str
    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.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthRegexTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthSubstringTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpAuthVariableExtractor

    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField string
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_auth_processing_variable_id str
    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.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpDefaultAuthzGroups

    GroupNames 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    GroupNames []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpDevRelations

    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDcpRealTimeAuth

    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname boolean
    Extracts a hostname from JWT.
    extractJurisdiction boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDeliveryReceipt

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDenyAccess

    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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDenyDirectFailoverAccess

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicCacheId

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDeviceCharacteristicHeader

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDnsAsyncRefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorDnsPrefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorDowngradeProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDownloadCompleteMarker

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDownloadNotification

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDownstreamCache

    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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 a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.

    GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorDynamicThroughtputOptimizationOverride

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorDynamicWebContent

    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_monitoring bool
    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.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEcmsBulkUpload

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDatabase

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern string
    Specifies the regular expression that matches the database name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEcmsDataset

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEcmsObjectKey

    Locked bool
    Indicates 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeConnect

    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements List<string>
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements []string
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines string
    Specifies the maximum number of lines to include in each log.
    aggregateSize string
    Specifies the log's maximum size.
    aggregateTime string
    Specifies how often logs are generated.
    apiConnector string
    Describes the API connector type.
    apiDataElements string[]
    Specifies the data set to log.
    destinationHostname string
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings boolean
    When enabled, overrides default log settings.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_elements Sequence[str]
    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_settings bool
    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.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenter

    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules List<GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules []GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenterFailoverRule
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description string
    Provides a description for the ELB data center, for your own reference.
    enableFailover boolean
    Allows you to specify failover rules.
    failoverRules GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenterFailoverRule[]
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_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[GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenterFailoverRule]
    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 the edgeLoadBalancingOrigin 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.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<Property Map>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingDataCenterFailoverRule

    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname string
    The hostname of the data center to fail over to.
    modifyRequest boolean
    Allows you to modify the request's hostname or path.
    overrideHostname 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.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeLoadBalancingOrigin

    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description string
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description str
    Provides a description for the ELB origin, for your own reference.
    enable_session_persistence bool
    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 the edgeLoadBalancingDataCenter 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_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.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeOriginAuthorization

    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookie_name 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirector

    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy 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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeRedirectorCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeScape

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeSideIncludes

    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets List<string>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets []string
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection boolean
    Denies attempts to inject ESI code.
    enableViaHttp boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled boolean
    Enables ESI processing.
    i18nCharsets string[]
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_http bool
    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 and ISO-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_ip bool
    Allows edge servers to pass the client IP header to the ESI processor.
    pass_set_cookie 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.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEdgeWorker

    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId string
    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.
    mPulse boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_worker str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edge_worker_id str
    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.
    m_pulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    m_pulse_information str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    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.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEnforceMtlsSettings

    CertificateAuthoritySets List<string>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateAuthoritySets []string
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets string[]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_authority_sets Sequence[str]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enable_auth_set bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enable_deny_request bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enable_ocsp_status bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked bool
    Indicates that your 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.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedAkamaiProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorEnhancedProxyDetection

    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction string
    Specifies how to field the proxy request.
    bestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction string
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy boolean
    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.
    detectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode string
    Specifies how to field the proxy request.
    enabled boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment boolean
    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.
    hostingProvider 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.
    publicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter string
    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_action str
    Specifies how to field the proxy request.
    best_practice_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_anonymous_vpn bool
    This enables detection of requests from anonymous VPNs.
    detect_anonymous_vpn_action str
    Specifies how to field anonymous VPN requests.
    detect_anonymous_vpn_redirecturl str
    This specifies the URL to which to redirect anonymous VPN requests.
    detect_hosting_provider bool
    This detects requests from a hosting provider.
    detect_hosting_provider_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detect_hosting_provider_redirecturl str
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detect_public_proxy bool
    This enables detection of requests from public proxies.
    detect_public_proxy_action str
    Specifies how to field public proxy requests.
    detect_public_proxy_redirecturl str
    This specifies the URL to which to redirect public proxy requests.
    detect_residential_proxy bool
    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_proxy_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detect_residential_proxy_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_smart_dns_proxy bool
    This enables detection of requests from smart DNS proxies.
    detect_smart_dns_proxy_action str
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detect_smart_dns_proxy_redirecturl str
    This specifies the URL to which to redirect DNS proxy requests.
    detect_tor_exit_node bool
    This enables detection of requests from Tor exit nodes.
    detect_tor_exit_node_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detect_tor_exit_node_redirecturl str
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detect_vpn_data_center bool
    This enables detection of requests from VPN data centers.
    detect_vpn_data_center_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detect_vpn_data_center_redirecturl str
    This specifies the URL to which to redirect requests from VPN data centers.
    enable_configuration_mode str
    Specifies how to field the proxy request.
    enabled bool
    Applies GeoGuard proxy detection.
    forward_header_enrichment bool
    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_proxy 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.
    tor_exit_node 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.
    vpn_data_center str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorEpdForwardHeaderEnrichment

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFailAction

    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20230920BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20230920BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20230920BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Integer
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Integer
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Integer
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride boolean
    cexCustomPath boolean
    Specifies a custom path.
    cexHostname string
    Specifies a hostname.
    cexPath string
    Specifies a custom path.
    contentCustomPath boolean
    Specifies a custom redirect path.
    contentHostname string
    Specifies the static hostname for the alternate redirect.
    contentPath string
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath boolean
    Allows you to modify the original requested path.
    dynamicMethod string
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20230920BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath boolean
    Uses the redirectPath to customize a new path.
    redirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType string
    Whether to preserve or customize the hostname.
    redirectMethod number
    Specifies the HTTP response code.
    redirectPath string
    Specifies a new path.
    saasCnameEnabled boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    saasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode number
    Assigns a new HTTP status code to the failure response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_parent_override bool
    cex_custom_path bool
    Specifies a custom path.
    cex_hostname str
    Specifies a hostname.
    cex_path str
    Specifies a custom path.
    content_custom_path bool
    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 GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamic_custom_path bool
    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_hostname GetPropertyRulesBuilderRulesV20230920BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    net_storage_path str
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserve_query_string bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol str
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirect_custom_path bool
    Uses the redirectPath to customize a new path.
    redirect_hostname str
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirect_hostname_type str
    Whether to preserve or customize the hostname.
    redirect_method int
    Specifies the HTTP response code.
    redirect_path str
    Specifies a new path.
    saas_cname_enabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saas_cname_level int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saas_query_string str
    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.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode Property Map
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname Property Map
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Number
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Number
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorFailActionCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorFailActionNetStorageHostname

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230920BehaviorFailoverBotManagerFeatureCompatibility

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFastInvalidate

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFips

    Enable bool
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    enable Boolean
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketing

    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlus

    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorFirstPartyMarketingPlusCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewrite

    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorForwardRewriteCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorG2oheader

    CustomSignStrings List<string>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    CustomSignStrings []string
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Integer
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customSignStrings string[]
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled boolean
    Enables the g2o verification behavior.
    encodingVersion number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked boolean
    Indicates 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.
    secretKey string
    Specifies the shared secret key.
    signedHeader string
    Specifies the name of the header containing encrypted request data.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_strings Sequence[str]
    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 through 5.
    locked bool
    Indicates 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_sign_string bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorGlobalRequestNumber

    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption string
    Specifies how to report the GRN value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorGraphqlCaching

    Advanced string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors boolean
    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.
    operationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_with_errors bool
    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_body_parameter_name str
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operations_url_query_parameter_name str
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    post_request_processing_error_handling str
    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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorGzipResponse

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorHdDataAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorHealthDetection

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects 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 of retryCount.
    retryCount Integer
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 of retryCount.
    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.
    maximumReconnects Number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount Number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorHsafEipBinding

    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Integer
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Integer
    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.
    templateUuid 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.
    customExtractedSerial boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue number
    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.
    templateUuid 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_serial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hash_max_value int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hash_min_value int
    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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Number
    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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorHttp2

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorHttp3

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorHttpStrictTransportSecurity

    Enable bool
    Applies HSTS to this set of requests.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Integer
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains boolean
    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.
    maxAge 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.
    redirectStatusCode number
    Specifies a response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_domains bool
    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_code int
    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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Number
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorHttpToHttpsUpgrade

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImOverride

    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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters List<string>
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters []string
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.
    excludeAllQueryParameters boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters string[]
    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.
    policyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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_query_parameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excluded_query_parameters Sequence[str]
    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_mvar str
    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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManager

    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    applyBestFileType Boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformed
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String
    applyBestFileType boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformed
    enabled boolean
    imageSet 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.
    policySetType string
    resize boolean
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet string
    apply_best_file_type bool
    cp_code_original GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginal
    cp_code_transformed GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformed
    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_type str
    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
    applyBestFileType Boolean
    cpCodeOriginal Property Map
    cpCodeTransformed Property Map
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String

    GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManager

    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    api_reference_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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_default str
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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_region str
    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_policy_set bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal Property Map
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideo

    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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_default str
    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_region str
    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_policy_set bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal Property Map
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorInclude

    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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorInstant

    CustomLinkRelations List<string>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions List<string>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLinkRelations []string
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions []string
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations string[]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions string[]
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_relations Sequence[str]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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 the tieredDistribution 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_store bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetch_no_store_extensions Sequence[str]
    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.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorInstantConfig

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimization

    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching string
    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.
    maximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid string
    This option is for internal usage only.
    useVersioning boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_object_caching str
    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 or GB. 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 or GB.
    template_uuid str
    This option is for internal usage only.
    use_versioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    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.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorLargeFileOptimizationAdvanced

    Enabled bool
    Enables the file optimization behavior.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Integer
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Integer
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest number
    The number of POC fragments to prefetch during the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or GB suffix.
    prefetch_after_request int
    The number of POC fragments to prefetch after the request.
    prefetch_during_request int
    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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Number
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRate

    BitrateTables List<GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables List<GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BitrateTables []GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateBitrateTable
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables []GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateThresholdTable
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables List<GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables List<GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateBitrateTable[]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid string
    This option is for internal usage only.
    thresholdTables GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateThresholdTable[]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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[GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateBitrateTable]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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[GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateThresholdTable]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    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.
    bitrateTables 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 numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables 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 numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateBitrateTable

    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue double
    The numeric indicator of the download rate.
    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue float64
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Double
    The numeric indicator of the download rate.
    bitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue number
    The numeric indicator of the download rate.
    bitrate_unit str
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrate_value float
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Number
    The numeric indicator of the download rate.

    GetPropertyRulesBuilderRulesV20230920BehaviorLimitBitRateThresholdTable

    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Integer
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue 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, or BYTES of the file size.
    threshold_value int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Number
    The numeric indicator of the minimum file size or elapsed download time.

    GetPropertyRulesBuilderRulesV20230920BehaviorLogCustom

    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_field str
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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_log_field bool
    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.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMPulse

    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    apiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid string
    This option is for internal usage only.
    titleOptional 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}}". See Configuration 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorManifestPersonalization

    Enabled bool
    Enables the Manifest Personalization feature.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges string
    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.
    hlsFilterInBitrates string
    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.
    hlsMode string
    Applies with hlsEnabled on.
    hlsPreferredBitrate string
    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.
    hlsQueryParamEnabled boolean
    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.
    hlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_debug_headers bool
    Includes additional Akamai-Manifest-Personalization and Akamai-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_in_bitrate_ranges str
    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_in_bitrates str
    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_bitrate str
    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_param_enabled bool
    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_param_secret_key str
    Specifies a primary key as a token to accompany the request.
    hls_query_param_transition_key str
    Specifies a transition key as a token to accompany the request.
    hls_show_advanced bool
    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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorManifestRerouting

    Locked bool
    Indicates 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorManualServerPush

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMediaAcceleration

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMediaAccelerationQuicOptout

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMediaClient

    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    beaconId 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.
    templateUuid string
    This option is for internal usage only.
    useHybridHttpUdp boolean
    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_http_udp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.

    GetPropertyRulesBuilderRulesV20230920BehaviorMediaFileRetrievalOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMediaOriginFailover

    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes []string
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes []string
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Integer
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Integer
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Integer
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse boolean
    When enabled, caches the error response.
    cacheWindow string
    This sets error response's TTL.
    clientResponseCode string
    Specifies the response code served to the client.
    detectObjectUnavailable boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost string
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery string
    This sets the recovery option.
    objectUnavailableRedirectMethod number
    Specifies a redirect response code.
    objectUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit string
    Sets how many times to retry.
    originUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost string
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath string
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath boolean
    Modifies the request path.
    originUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery string
    This sets the recovery option.
    originUnavailableRedirectMethod number
    Specifies either a redirect response code.
    originUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit string
    Sets how many times to retry.
    originUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost string
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath boolean
    Modifies the request path.
    originUnresponsiveProtocol string
    Specifies which protocol to use.
    originUnresponsiveRecovery string
    This sets the recovery option.
    originUnresponsiveRedirectMethod number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit string
    Sets how many times to retry.
    otherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response bool
    When enabled, caches the error response.
    cache_window str
    This sets error response's TTL.
    client_response_code str
    Specifies the response code served to the client.
    detect_object_unavailable bool
    Allows you to configure failover settings when the origin has content errors.
    detect_object_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    detect_origin_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    detect_origin_unresponsive_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.
    object_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    object_unavailable_backup_host str
    This specifies the origin hostname.
    object_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    object_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    object_unavailable_change_protocol bool
    Changes the request protocol.
    object_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    object_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    object_unavailable_modified_path str
    This specifies the path to form the new URL.
    object_unavailable_modify_request_path bool
    Enabling this allows you to modify the request path.
    object_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    object_unavailable_recovery str
    This sets the recovery option.
    object_unavailable_redirect_method int
    Specifies a redirect response code.
    object_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when there are content errors.
    object_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unavailable_backup_host str
    This specifies the origin hostname.
    origin_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unavailable_change_protocol bool
    Modifies the request protocol.
    origin_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    origin_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unavailable_modified_path str
    This specifies the path to form the new URL.
    origin_unavailable_modify_request_path bool
    Modifies the request path.
    origin_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    origin_unavailable_recovery str
    This sets the recovery option.
    origin_unavailable_redirect_method int
    Specifies either a redirect response code.
    origin_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when the origin responds with errors.
    origin_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unresponsive_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unresponsive_backup_host str
    This specifies the origin hostname.
    origin_unresponsive_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unresponsive_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unresponsive_change_protocol bool
    This allows you to change the request protocol.
    origin_unresponsive_detection_level str
    Specify the level of response to slow origin connections.
    origin_unresponsive_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unresponsive_modified_path str
    This specifies the path to form the new URL.
    origin_unresponsive_modify_request_path bool
    Modifies the request path.
    origin_unresponsive_protocol str
    Specifies which protocol to use.
    origin_unresponsive_recovery str
    This sets the recovery option.
    origin_unresponsive_redirect_method int
    Specifies the redirect response code.
    origin_unresponsive_retry_limit str
    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.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Number
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Number
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMetadataCaching

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorMobileSdkPerformance

    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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to_origin bool
    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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingRequestHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Supplies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Supplies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorModifyIncomingResponseHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Specifies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingRequestHeader

    Action string
    Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies an HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorModifyOutgoingResponseHeader

    Action string
    Either ADD or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies the new HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies the new HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorModifyViaHeader

    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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption string
    Specify how you want to handle the header.
    renameHeaderTo string
    Specifies a new name to replace the existing Via header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to str
    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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorOrigin

    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities List<GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthority>
    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.
    CustomCertificates List<GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificate>
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues List<string>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20230920BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities List<string>
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities []GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthority
    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.
    CustomCertificates []GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificate
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues []string
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20230920BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities []string
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities List<GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthority>
    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.
    customCertificates List<GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificate>
    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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Integer
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort 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. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20230920BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Integer
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    compress boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthority[]
    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.
    customCertificates GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificate[]
    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.
    customForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues string[]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin string
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20230920BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor string
    Specifies which certificate to trust.
    originId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace string
    Specifies replacement text for what saasRegex matches.
    saasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    saasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities string[]
    templateUuid string
    This option is for internal usage only.
    tls13Support boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting boolean
    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.
    trueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey boolean
    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.
    verificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cache_key_hostname str
    Specifies the hostname to use when forming a cache key.
    compress bool
    Enables gzip compression for non-NetStorage origins.
    custom_certificate_authorities Sequence[GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthority]
    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[GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificate]
    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_host_header str
    This specifies the name of the custom host header the edge server should pass to the origin.
    custom_valid_cn_values Sequence[str]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enable_true_client_ip bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forward_host_header str
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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. See Secure 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.
    max_tls_version str
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    min_tls_version str
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin str
    This specifies the media's origin server.
    net_storage GetPropertyRulesBuilderRulesV20230920BehaviorOriginNetStorage
    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_to_honor str
    Specifies which certificate to trust.
    origin_id str
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id 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.
    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_enabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saas_cname_level int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saas_query_string str
    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_enabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standard_certificate_authorities Sequence[str]
    template_uuid str
    This option is for internal usage only.
    tls13_support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tls_version_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    true_client_ip_client_setting bool
    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_ip_header str
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    use_unique_cache_key bool
    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.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities 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.
    customCertificates 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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort Number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage Property Map
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristics

    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings List<string>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings []string
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Integer
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    accessKeyEncryptedStorage boolean
    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.
    adcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod string
    Specifies the authentication method.
    authenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion string
    awsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings string[]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo string
    Provides a region used by Akamai Direct Connection.
    encodingVersion number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService string
    gcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag boolean
    locked boolean
    Indicates 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.
    originLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag boolean
    roleArn string
    secretKey string
    Specifies the shared secret key.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    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_encrypted_storage bool
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    aws_access_key_id str
    Specifies active access key ID linked to your AWS account.
    aws_access_key_version_guid str
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    aws_ar_region str
    aws_host str
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    aws_region str
    This specifies the AWS region code of the location where your bucket resides.
    aws_secret_access_key str
    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_strings Sequence[str]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    direct_connect_geo str
    Provides a region used by Akamai Direct Connection.
    encoding_version int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    end_point_service str
    gcs_access_key_version_guid str
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcs_hmac_key_access_id str
    Specifies the active access ID linked to your Google account.
    gcs_hmac_key_secret str
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostname_tag bool
    locked bool
    Indicates 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.
    origin_location_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    property_id_tag bool
    role_arn str
    secret_key str
    Specifies the shared secret key.
    template_uuid str
    This option is for internal usage only.
    use_custom_sign_string bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCharacteristicsWsd

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificate

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthority

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthorityIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateAuthoritySubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginCustomCertificateSubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryMethod

    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode string
    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.
    recoveryMethod string
    Specifies the recovery method.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_code str
    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.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginFailureRecoveryPolicy

    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Integer
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Integer
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Integer
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    binaryEquivalentContent boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval number
    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.
    monitorOriginResponsiveness boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    tuningParameters 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_content bool
    Synchronizes content between the primary and backup origins, byte for byte.
    enable_ip_avoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled bool
    Activates and configures a recovery policy.
    ip_avoidance_error_threshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ip_avoidance_retry_interval int
    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_responsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitor_response_codes1s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes2s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes3s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitor_status_codes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes1_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes1_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes1_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes2_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes2_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes2_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes3_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes3_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes3_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_custom_timeout int
    Specify a custom timeout, from 1 to 10 seconds.
    origin_responsiveness_enable_recovery bool
    Enables a recovery action for a specific failure condition.
    origin_responsiveness_enable_retry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    origin_responsiveness_monitoring str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    origin_responsiveness_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_timeout str
    The timeout threshold that triggers a retry or recovery action.
    status_code_monitoring1 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring2 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring3 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.
    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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Number
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginIpAcl

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorOriginNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230920BehaviorPermissionsPolicy

    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives List<string>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives []string
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives string[]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_list str
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissions_policy_directives Sequence[str]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPersistentClientConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorPersistentConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorPersonallyIdentifiableInformation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPhasedRelease

    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes List<string>
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes []string
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes string[]
    Defines the set of failure codes that initiate the failover response.
    failoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate string
    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.
    populationRefresh boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    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_codes Sequence[str]
    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.
    is_shared_policy 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.
    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.
    population_cookie_type 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 effectively NONE.
    population_duration str
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    population_expiration_date str
    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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPhasedReleaseCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorPreconnect

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Preconnectlists List<string>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Preconnectlists []string
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists string[]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists Sequence[str]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPredictiveContentDelivery

    Enabled bool
    Enables the predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPredictivePrefetching

    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled boolean
    Enables the predictive prefetching 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracy_target str
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled bool
    Enables the predictive prefetching 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.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPrefetch

    Enabled bool
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPrefetchable

    Enabled bool
    Allows matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked bool
    Indicates that your 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorPrefreshCache

    Enabled bool
    Enables the cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval Integer
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    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 cache prefreshing 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.
    prefreshval Number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorQuality

    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Integer
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize string
    contentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType string
    country string
    deliveryFormat string
    deliveryType string
    downloadType string
    endUserLocation 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.
    maximumConcurrentUsers string
    objectSize string
    optimizeFor string
    originSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution string
    refreshRate string
    segmentDuration number
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audience_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalog_size str
    content_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    content_type str
    country str
    delivery_format str
    delivery_type str
    download_type str
    end_user_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.
    maximum_concurrent_users str
    object_size str
    optimize_for str
    origin_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularity_distribution str
    refresh_rate str
    segment_duration int
    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.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Number
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorQuicBeta

    Enabled bool
    Enables QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Integer
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quic_offer_percentage int
    The percentage of responses for which to allow QUIC sessions.
    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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRandomSeek

    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv boolean
    Enables random seek optimization in FLV files.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 boolean
    Enables random seek optimization in MP4 files.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv bool
    Enables random seek optimization in FLV files.
    locked bool
    Indicates 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
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 bool
    Enables random seek optimization in MP4 files.
    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.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRapid

    Enabled bool
    Enables API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorReadTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked bool
    Indicates that your 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.

    GetPropertyRulesBuilderRulesV20230920BehaviorRealTimeReporting

    Advanced bool
    Enables advanced options.
    BeaconSamplingPercentage double
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    BeaconSamplingPercentage float64
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage Double
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage number
    Specifies the percentage for sampling.
    enabled boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beacon_sampling_percentage float
    Specifies the percentage for sampling.
    enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked bool
    Indicates that your 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.
    advanced Boolean
    Enables advanced options.
    beaconSamplingPercentage Number
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRealUserMonitoring

    Enabled bool
    When enabled, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked bool
    Indicates that your 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRedirect

    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Integer
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol string
    Choose the protocol for the redirect URL.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    queryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode number
    Specify the redirect's response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination_hostname str
    Specify how to change the requested hostname, independently from the pathname.
    destination_hostname_other str
    Specifies the full hostname with which to replace the current hostname.
    destination_hostname_sibling str
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destination_hostname_subdomain str
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destination_path str
    Specify how to change the requested pathname, independently from the hostname.
    destination_path_other str
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destination_path_prefix str
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destination_path_suffix str
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destination_path_suffix_status str
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destination_protocol str
    Choose the protocol for the redirect URL.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobile_default_choice str
    Either specify a default response for mobile browsers, or customize your own.
    query_string str
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    response_code int
    Specify the redirect's 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.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Number
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRedirectplus

    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Integer
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled boolean
    Enables the redirect 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.
    responseCode number
    Assigns the status code for the redirect response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination str
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled bool
    Enables the redirect 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.
    response_code int
    Assigns the status code for the redirect 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.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Number
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRefererChecking

    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains List<string>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains []string
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains string[]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled boolean
    Enables the referer-checking 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.
    strict boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_children bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains Sequence[str]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled bool
    Enables the referer-checking 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.
    strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    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.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRemoveQueryParameter

    Locked bool
    Indicates 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 parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Parameters []string
    Specifies parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters List<String>
    Specifies parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters string[]
    Specifies parameters to remove from the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters Sequence[str]
    Specifies parameters to remove from 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.
    locked Boolean
    Indicates 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 parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRemoveVary

    Enabled bool
    When enabled, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked bool
    Indicates that your 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorReport

    Cookies List<string>
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Cookies []string
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies string[]
    This specifies the set of cookies names whose values you want to log.
    customLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage boolean
    Log the Accept-Language header.
    logCookies string
    Specifies the set of cookies to log.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    logEdgeIp boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost boolean
    Log the Host header.
    logReferer boolean
    Log the Referer header.
    logUserAgent boolean
    Log the User-Agent header.
    logXForwardedFor boolean
    Log any X-Forwarded-For request header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies Sequence[str]
    This specifies the set of cookies names whose values you want to log.
    custom_log_field str
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked bool
    Indicates 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_accept_language bool
    Log the Accept-Language header.
    log_cookies str
    Specifies the set of cookies to log.
    log_custom_log_field bool
    Whether to append additional custom data to each log line.
    log_edge_ip bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    log_host bool
    Log the Host header.
    log_referer bool
    Log the Referer header.
    log_user_agent bool
    Log the User-Agent header.
    log_x_forwarded_for bool
    Log any X-Forwarded-For request 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.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRequestClientHints

    AcceptChes List<string>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes List<string>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AcceptChes []string
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes []string
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes string[]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes string[]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accept_ches Sequence[str]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    accept_critical_ches Sequence[str]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your 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.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRequestControl

    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Integer
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Integer
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode number
    Specifies the response status code for the branded deny action.
    branded403Url string
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403_file str
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403_status_code int
    Specifies the response status code for the branded deny action.
    branded403_url str
    Specifies the redirect URL for the branded deny action.
    branded_deny_cache_ttl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enable_branded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled bool
    Enables the Request Control Cloudlet.
    is_shared_policy 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.
    net_storage GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    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.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Number
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage Property Map
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorRequestControlNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230920BehaviorRequestTypeMarker

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType string
    Specifies the type of request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    request_type str
    Specifies the type of 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizer

    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorResourceOptimizerExtendedCompatibility

    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures boolean
    Enables additional support and error handling.
    enabled boolean
    Enables the Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_all_features bool
    Enables additional support and error handling.
    enabled bool
    Enables the Resource Optimizer 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.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Integer
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode number
    The HTTP status code to replace the existing one.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    status_code int
    The HTTP status code to replace the existing one.
    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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Number
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorResponseCookie

    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled boolean
    Allows you to set a response cookie.
    expirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires string
    Sets various ways to specify when the cookie expires.
    format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid string
    This option is for internal usage only.
    type string
    What type of value to assign.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookie_name str
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    default_domain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    default_path bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain str
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration str
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled bool
    Allows you to set a response cookie.
    expiration_date str
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires str
    Sets various ways to specify when the cookie expires.
    format str
    When the type of cookie is set to UNIQUE, this sets the date format.
    http_only bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path str
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    same_site str
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    template_uuid str
    This option is for internal usage only.
    type str
    What type of value to assign.
    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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.

    GetPropertyRulesBuilderRulesV20230920BehaviorRestrictObjectCaching

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_size str
    Specifies a fixed maximum size of non-HTML content to cache.
    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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorReturnCacheStatus

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    response_header_name str
    Specifies the name of the HTTP header in which to report the cache status 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRewriteUrl

    Behavior string
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString boolean
    When enabled, retains the original path's query parameters.
    locked boolean
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keep_query_string bool
    When enabled, retains the original path's query parameters.
    locked bool
    Indicates 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 str
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    match_multiple bool
    When enabled, replaces all potential matches rather than only the first.
    match_regex str
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    target_path str
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    target_path_prepend str
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    target_regex str
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    target_url str
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorRumCustom

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Integer
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rum_group_name str
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rum_sample_rate int
    Specifies the percentage of web traffic to include in your RUM 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSaasDefinitions

    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    applicationAction string
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie string
    This specifies the name of the cookie that identifies the application.
    applicationQueryString string
    This names the query parameter that identifies the application.
    applicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction string
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie string
    This specifies the name of the cookie that identifies the customer.
    customerQueryString string
    This names the query parameter that identifies the customer.
    customerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid string
    This option is for internal usage only.
    usersAction string
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie string
    This specifies the name of the cookie that identifies the user.
    usersQueryString string
    This names the query parameter that identifies the user.
    usersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    application_action str
    Specifies the request component that identifies a SaaS application.
    application_cname_enabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    application_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    application_cookie str
    This specifies the name of the cookie that identifies the application.
    application_query_string str
    This names the query parameter that identifies the application.
    application_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    application_replace str
    Specifies a string to replace the request's application ID matched by applicationRegex.
    application_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customer_action str
    Specifies the request component that identifies a SaaS customer.
    customer_cname_enabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customer_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    customer_cookie str
    This specifies the name of the cookie that identifies the customer.
    customer_query_string str
    This names the query parameter that identifies the customer.
    customer_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customer_replace str
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customer_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.
    users_action str
    Specifies the request component that identifies a SaaS user.
    users_cname_enabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    users_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    users_cookie str
    This specifies the name of the cookie that identifies the user.
    users_query_string str
    This names the query parameter that identifies the user.
    users_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    users_replace str
    Specifies a string to replace the request's user ID matched by usersRegex.
    users_title 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudClient

    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader string
    Specifies where the Host header is defined.
    originType string
    Specifies where the origin is.
    sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_override_origin_cache_key bool
    When enabled, overrides the forwarding origin's cache key.
    connector_id str
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked bool
    Indicates 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_host_header str
    Specifies where the Host header is defined.
    origin_type str
    Specifies where the origin is.
    sf3c_origin_host str
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3c_origin_host_header str
    This specifies the hostname or IP address of the custom Salesforce host 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.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProvider

    Enabled bool
    Enables Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked bool
    Indicates that your 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSalesForceCommerceCloudProviderHostHeader

    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource string
    Specify where the host header derives 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    host_header_source str
    Specify where the host header derives 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.
    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.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSavePostDcaProcessing

    Enabled bool
    Enables processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    enabled Boolean
    Enables processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorScheduleInvalidation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod string
    Specifies how to invalidate the content.
    repeat boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start string
    The UTC date and time when matching cached content is to expire.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refresh_method str
    Specifies how to invalidate the content.
    repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeat_interval str
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start str
    The UTC date and time when matching cached content is to expire.
    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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorScriptManagement

    Enabled bool
    Enables the Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Integer
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid string
    This option is for internal usage only.
    timestamp number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker str
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    template_uuid str
    This option is for internal usage only.
    timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedContentProtection

    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts List<string>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles List<string>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts []string
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles []string
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Integer
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption boolean
    Whether to enable DASH Media Encryption.
    dataPayload boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled boolean
    Enables the segmented content protection behavior.
    fieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts string[]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles string[]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption boolean
    Enables HLS Segment Encryption.
    ip boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid string
    This option is for internal usage only.
    tokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dash_media_encryption bool
    Whether to enable DASH Media Encryption.
    data_payload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enable_token_in_uri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled bool
    Enables the segmented content protection behavior.
    field_carry_over str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    header_for_salts Sequence[str]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hls_master_manifest_files Sequence[str]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hls_media_encryption bool
    Enables HLS Segment Encryption.
    ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key str
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked bool
    Indicates 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_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revoked_list_id int
    Identifies the TokenAuth tokens to block from accessing your content.
    salt str
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    session_id bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    template_uuid str
    This option is for internal usage only.
    token_auth_hls_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_authentication_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_revocation_enabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    token_revocation_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transition_key str
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    use_advanced bool
    Allows you to specify advanced transitionKey and salt options.
    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.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaOptimization

    Behavior string
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType string
    The type of DVR.
    dvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime string
    This specifies when the live media event ends.
    liveType string
    The type of live 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.
    showAdvanced boolean
    Allows you to configure advanced media options.
    startTime string
    This specifies when the live media event begins.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvr_type str
    The type of DVR.
    dvr_window str
    Set the duration for your media, or 0m if a DVR is not required.
    enable_ull_streaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    end_time str
    This specifies when the live media event ends.
    live_type str
    The type of live 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.
    show_advanced bool
    Allows you to configure advanced media options.
    start_time str
    This specifies when the live media event begins.
    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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSegmentedMediaStreamingPrefetch

    Enabled bool
    Enables media stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked bool
    Indicates that your 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSetVariable

    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Integer
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Integer
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Integer
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Integer
    Specifies a maximum value for the generated integer.
    maxRandomNumber Integer
    Specifies the upper bound of the random number.
    min Integer
    Specifies a minimum value for the generated integer.
    minRandomNumber Integer
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Integer
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Integer
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm string
    Specifies the algorithm to apply.
    caseSensitive boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName string
    Specifies the certificate's content.
    cookieName string
    Specifies the name of the cookie to extract.
    deviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode string
    Specifies the encryption mode.
    endIndex number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation string
    This specifies from where to get the value.
    forceChars string
    Specifies characters to encode, possibly overriding the default set.
    formatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator string
    This specifies the type of value to generate.
    globalSubstitution boolean
    Replaces all matches in the string, not just the first.
    headerName string
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion string
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked boolean
    Indicates 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 number
    Specifies a maximum value for the generated integer.
    maxRandomNumber number
    Specifies the upper bound of the random number.
    min number
    Specifies a minimum value for the generated integer.
    minRandomNumber number
    Specifies the lower bound of the random number.
    nonce string
    Specifies the one-time number used for encryption.
    numberOfBytes number
    Specifies the number of random hex bytes to generate.
    operandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    separator string
    Specifies the character that separates pairs of values within the string.
    setCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    startIndex number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid string
    This option is for internal usage only.
    transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource string
    Determines how you want to set the value.
    variableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm str
    Specifies the algorithm to apply.
    case_sensitive bool
    Enabling this makes all matches case sensitive.
    certificate_field_name str
    Specifies the certificate's content.
    cookie_name str
    Specifies the name of the cookie to extract.
    device_profile str
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryption_key str
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryption_mode str
    Specifies the encryption mode.
    end_index int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    except_chars str
    Specifies characters not to encode, possibly overriding the default set.
    extract_location str
    This specifies from where to get the value.
    force_chars str
    Specifies characters to encode, possibly overriding the default set.
    format_string str
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator str
    This specifies the type of value to generate.
    global_substitution bool
    Replaces all matches in the string, not just the first.
    header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    hmac_algorithm str
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmac_key str
    Specifies the secret to use in generating the base64-encoded digest.
    initialization_vector str
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ip_version str
    Specifies the IP version under which a subnet mask generates.
    ipv4_prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6_prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    location_id str
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    max_random_number int
    Specifies the upper bound of the random number.
    min int
    Specifies a minimum value for the generated integer.
    min_random_number int
    Specifies the lower bound of the random number.
    nonce str
    Specifies the one-time number used for encryption.
    number_of_bytes int
    Specifies the number of random hex bytes to generate.
    operand_one str
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    param_name str
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    path_component_offset str
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prepend_bytes bool
    Specifies a number of random bytes to prepend to the key.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the value.
    regex str
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement str
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    response_header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    separator str
    Specifies the character that separates pairs of values within the string.
    set_cookie_name str
    Specifies the name of the origin's Set-Cookie response header.
    start_index int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    sub_string str
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    template_uuid str
    This option is for internal usage only.
    transform str
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    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_source str
    Determines how you want to set the value.
    variable_name str
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variable_value str
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Number
    Specifies a maximum value for the generated integer.
    maxRandomNumber Number
    Specifies the upper bound of the random number.
    min Number
    Specifies a minimum value for the generated integer.
    minRandomNumber Number
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Number
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.

    GetPropertyRulesBuilderRulesV20230920BehaviorSimulateErrorCode

    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType string
    Specifies the type of 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.
    templateUuid string
    This option is for internal usage only.
    timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    error_type str
    Specifies the type of 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.
    timeout str
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    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.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSiteShield

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20230920BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20230920BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230920BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230920BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20230920BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap Property Map
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorSiteShieldSsmap

    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String
    chinaCdnMap string
    hasMixedHosts boolean
    name string
    src string
    srmap string
    value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String

    GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigration

    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Integer
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Integer
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration number
    Specifies the number cache sharing days.
    cacheSharingStartTime string
    Specifies when to start cache sharing.
    enabled boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration number
    Specifies the number of days to migrate the cache.
    migrationFrom string
    What kind of traffic you're migrating from.
    migrationStartTime string
    Specifies when to start migrating the cache.
    tdLocation string
    Specifies the tieredDistribution location.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_https_downgrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allow_https_upgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cache_sharing_duration int
    Specifies the number cache sharing days.
    cache_sharing_start_time str
    Specifies when to start cache sharing.
    enabled bool
    Allows migration to Standard TLS.
    is_certificate_sni_only bool
    Sets whether your new certificate is SNI-only.
    is_tiered_distribution_used bool
    Allows you to align traffic to various tieredDistribution areas.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migration_duration int
    Specifies the number of days to migrate the cache.
    migration_from str
    What kind of traffic you're migrating from.
    migration_start_time str
    Specifies when to start migrating the cache.
    td_location str
    Specifies the tieredDistribution location.
    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.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Number
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Number
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorStandardTlsMigrationOverride

    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorStrictHeaderParsing

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strict_mode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers 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.
    valid_mode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.

    GetPropertyRulesBuilderRulesV20230920BehaviorSubCustomer

    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey boolean
    Allows you to set which query parameters are included in the cache key.
    caching boolean
    Modifies content caching rules.
    contentCompressor boolean
    Allows compression of subcustomer content.
    dynamicWebContent boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery boolean
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery boolean
    Enables delivery of media assets to subcustomers.
    origin boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid string
    This option is for internal usage only.
    tokenAuthorization boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    access_control bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cache_key bool
    Allows you to set which query parameters are included in the cache key.
    caching bool
    Modifies content caching rules.
    content_compressor bool
    Allows compression of subcustomer content.
    dynamic_web_content bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geo_location bool
    Sets subcustomers' location-based whitelists or blacklists.
    ip bool
    Sets subcustomers' IP whitelists or blacklists.
    large_file_delivery bool
    Enables large file delivery for subcustomers.
    live_video_delivery bool
    locked bool
    Indicates 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_path bool
    Modifies a subcustomer's request path.
    on_demand_video_delivery bool
    Enables delivery of media assets to subcustomers.
    origin bool
    Allows you to assign origin hostnames for customers.
    partner_domain_suffix str
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    refresh_content bool
    Allows you to reschedule when content validates for subcustomers.
    site_failover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    template_uuid str
    This option is for internal usage only.
    token_authorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    web_application_firewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.

    GetPropertyRulesBuilderRulesV20230920BehaviorSureRoute

    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride boolean
    customMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    testObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus string
    Specifies which hostname to use.
    type string
    Specifies the set of edge servers used to test routes.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_fcm_parent_override bool
    custom_map str
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    custom_stat_key str
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enable_custom_key bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    force_ssl_forward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    race_stat_ttl str
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    sr_download_link_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.
    test_object_url str
    Specifies the path and filename for your origin's test object to use in races to test routes.
    to_host str
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    to_host_status str
    Specifies which hostname to use.
    type str
    Specifies the set of edge servers used to test routes.
    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.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorTcpOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorTeaLeaf

    Enabled bool
    When enabled, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Integer
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibm_customer_id int
    The integer identifier for the IBM Tealeaf Connector account.
    limit_to_dynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistribution

    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked bool
    Indicates that your 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.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionAdvanced

    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall boolean
    enabled boolean
    When enabled, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method string
    policy string
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall bool
    enabled bool
    When enabled, activates tiered distribution.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method str
    policy str
    template_uuid str
    This option is for internal usage only.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorTieredDistributionCustomization

    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled boolean
    Enables custom maps.
    customMapName string
    Specifies the custom map name.
    hashAlgorithm string
    Specifies the hash algorithm.
    location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate string
    Specifies when the map migration should end.
    migrationStartDate string
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart string
    Specifies a numeric serial start value.
    templateUuid string
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapper_map_migration_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    custom_map_enabled bool
    Enables custom maps.
    custom_map_name str
    Specifies the custom map name.
    hash_algorithm str
    Specifies the hash algorithm.
    location str
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    map_migration_enabled bool
    Enables migration of the custom map to Cloud Wrapper.
    migration_end_date str
    Specifies when the map migration should end.
    migration_start_date str
    Specifies when to start migrating the map.
    migration_within_cw_maps_enabled bool
    Enables migration within Cloud Wrapper maps.
    serial_end str
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serial_start str
    Specifies a numeric serial start value.
    template_uuid str
    This option is for internal usage only.
    tier1_title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked bool
    Indicates that your 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.

    GetPropertyRulesBuilderRulesV20230920BehaviorUidConfiguration

    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled boolean
    Allows you to extract UIDs from client requests.
    extractLocation string
    Where to extract the UID value from.
    headerName string
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled bool
    Allows you to extract UIDs from client requests.
    extract_location str
    Where to extract the UID value from.
    header_name str
    This specifies the name of the HTTP header from which to extract the UID value.
    legal_text 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.
    query_parameter_name str
    This specifies the name of the query parameter from which to extract the UID 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 rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.

    GetPropertyRulesBuilderRulesV20230920BehaviorValidateEntityTag

    Enabled bool
    Enables the ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebToken

    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation string
    Specify from where to extract the JWT value.
    headerName string
    This specifies the name of the header from which to extract the JWT value.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extract_location str
    Specify from where to extract the JWT value.
    header_name str
    This specifies the name of the header from which to extract the JWT value.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates 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_name str
    This specifies the name of the query parameter from which to extract the JWT 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.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorVerifyJsonWebTokenForDcp

    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.
    authorizations string
    This specifies the authorization group name.
    clientId string
    This specifies the claim name.
    customHeader boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation string
    Specifies where to get the JWT value from.
    extractUserName boolean
    Allows you to extract the user name stored in the JWT.
    headerName string
    This specifies the name of the header to extract the JWT value from.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    userName string
    This specifies the user 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.
    authorizations str
    This specifies the authorization group name.
    client_id str
    This specifies the claim name.
    custom_header bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enable_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extract_authorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    extract_client_id bool
    Allows you to extract the client ID claim name stored in JWT.
    extract_location str
    Specifies where to get the JWT value from.
    extract_user_name bool
    Allows you to extract the user name stored in the JWT.
    header_name str
    This specifies the name of the header to extract the JWT value from.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primary_location str
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the JWT value.
    template_uuid str
    This option is for internal usage only.
    user_name str
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorVerifyTokenAuthorization

    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location string
    Specifies where to find the token in the incoming request.
    locationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid string
    This option is for internal usage only.
    transitionKey string
    Specifies a transition key as a hex value.
    useAdvanced boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm str
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escape_hmac_inputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    failure_response bool
    When enabled, sends an HTTP error when an authentication test fails.
    ignore_query_string bool
    Enabling this removes the query string from the URL used to form an encryption key.
    key str
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location str
    Specifies where to find the token in the incoming request.
    location_id str
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt str
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    template_uuid str
    This option is for internal usage only.
    transition_key str
    Specifies a transition key as a hex value.
    use_advanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    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.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoom

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorVirtualWaitingRoomWithEdgeWorkers

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritization

    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders List<string>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams List<string>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders []string
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams []string
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Integer
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Integer
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Integer
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Integer
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Visitor Prioritization 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.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp boolean
    Allows IP addresses to identify users.
    userIdentificationByParams boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders string[]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams string[]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowed_user_cookie_advanced bool
    Sets advanced configuration options for the allowed user's cookie.
    allowed_user_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowed_user_cookie_domain str
    Specifies a domain for an allowed user cookie.
    allowed_user_cookie_domain_type str
    Specify with allowedUserCookieAdvanced enabled.
    allowed_user_cookie_duration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowed_user_cookie_enabled bool
    Sets a cookie for users who have been allowed through to the site.
    allowed_user_cookie_http_only bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowed_user_cookie_label str
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowed_user_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowed_user_cookie_refresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowed_user_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudlet_policy GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Visitor Prioritization 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.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by the values of GET or POST request headers.
    user_identification_by_ip bool
    Allows IP addresses to identify users.
    user_identification_by_params bool
    When enabled, identifies users by the values of GET or POST request parameters.
    user_identification_key_cookie str
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    user_identification_key_headers Sequence[str]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    user_identification_key_params Sequence[str]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    user_identification_title 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.
    waiting_room_cache_ttl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waiting_room_cookie_advanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waiting_room_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waiting_room_cookie_domain str
    Specifies a domain for the waiting room cookie.
    waiting_room_cookie_domain_type str
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waiting_room_cookie_duration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waiting_room_cookie_enabled bool
    Enables a cookie to track a waiting room assignment.
    waiting_room_cookie_http_only bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waiting_room_cookie_label str
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waiting_room_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waiting_room_cookie_share_label bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waiting_room_cp_code GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waiting_room_directory str
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waiting_room_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_net_storage GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waiting_room_status_code int
    Specifies the response code for requests sent to the waiting room.
    waiting_room_use_cp_code bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode Property Map
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage Property Map
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifo

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies how to set the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationFifoStandalone

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920BehaviorVisitorPrioritizationWaitingRoomNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20230920BehaviorWatermarking

    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid string
    This option is for internal usage only.
    tokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 string
    Specifies a unique identifier for the first public key.
    verificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 string
    Specifies the first public key in its entirety.
    verificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    ab_variant_location str
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryption_password1 str
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryption_password2 str
    Provides the secondary password you can use to rotate passwords.
    decryption_password_id1 str
    Specifies a label that corresponds to the primary password.
    decryption_password_id2 str
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable bool
    Enables the watermarking 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.
    miscellaneous_settings_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    pattern_decryption_enable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    pattern_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signature_verification_enable bool
    When enabled, you can verify the signature in your watermarking token.
    template_uuid str
    This option is for internal usage only.
    token_signing_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    use_original_as_a bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    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_key_id1 str
    Specifies a unique identifier for the first public key.
    verification_key_id2 str
    Specifies a unique identifier for the optional second public key.
    verification_public_key1 str
    Specifies the first public key in its entirety.
    verification_public_key2 str
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.

    GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewall

    FirewallConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FirewallConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewall_configuration GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    firewallConfiguration Property Map
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorWebApplicationFirewallFirewallConfiguration

    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Integer
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId number
    fileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    config_id int
    file_name str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Number
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior

    GetPropertyRulesBuilderRulesV20230920BehaviorWebSockets

    Enabled bool
    Enables WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920BehaviorWebdav

    Enabled bool
    Enables the WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920Criterion

    AdvancedImMatch GetPropertyRulesBuilderRulesV20230920CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20230920CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20230920CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20230920CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20230920CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20230920CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20230920CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20230920CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20230920CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20230920CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20230920CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20230920CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20230920CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20230920CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20230920CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20230920CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20230920CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20230920CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20230920CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20230920CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20230920CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20230920CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20230920CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20230920CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20230920CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20230920CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20230920CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20230920CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20230920CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20230920CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20230920CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20230920CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20230920CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20230920CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20230920CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20230920CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20230920CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20230920CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20230920CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20230920CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230920CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230920CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    AdvancedImMatch GetPropertyRulesBuilderRulesV20230920CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20230920CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20230920CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20230920CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20230920CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20230920CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20230920CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20230920CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20230920CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20230920CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20230920CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20230920CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20230920CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20230920CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20230920CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20230920CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20230920CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20230920CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20230920CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20230920CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20230920CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20230920CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20230920CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20230920CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20230920CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20230920CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20230920CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20230920CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20230920CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20230920CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20230920CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20230920CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20230920CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20230920CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20230920CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20230920CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20230920CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20230920CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20230920CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20230920CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230920CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230920CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20230920CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230920CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230920CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20230920CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20230920CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20230920CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20230920CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20230920CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20230920CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20230920CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20230920CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20230920CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20230920CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20230920CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20230920CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230920CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230920CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20230920CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20230920CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20230920CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20230920CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20230920CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230920CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20230920CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230920CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20230920CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20230920CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20230920CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20230920CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20230920CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20230920CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20230920CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20230920CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20230920CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230920CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20230920CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20230920CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20230920CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20230920CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20230920CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230920CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230920CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20230920CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230920CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230920CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20230920CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20230920CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20230920CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20230920CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20230920CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20230920CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20230920CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20230920CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20230920CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20230920CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20230920CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20230920CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230920CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230920CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20230920CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20230920CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20230920CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20230920CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20230920CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230920CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20230920CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230920CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20230920CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20230920CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20230920CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20230920CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20230920CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20230920CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20230920CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20230920CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20230920CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230920CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20230920CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20230920CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20230920CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20230920CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20230920CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20230920CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20230920CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advanced_im_match GetPropertyRulesBuilderRulesV20230920CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20230920CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20230920CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    china_cdn_region GetPropertyRulesBuilderRulesV20230920CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    client_certificate GetPropertyRulesBuilderRulesV20230920CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    client_ip GetPropertyRulesBuilderRulesV20230920CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    client_ip_version GetPropertyRulesBuilderRulesV20230920CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudlets_origin GetPropertyRulesBuilderRulesV20230920CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    content_delivery_network GetPropertyRulesBuilderRulesV20230920CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    content_type GetPropertyRulesBuilderRulesV20230920CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    device_characteristic GetPropertyRulesBuilderRulesV20230920CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmd_auth_groups GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmd_auth_scheme GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmd_is_authenticated GetPropertyRulesBuilderRulesV20230920CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmd_username GetPropertyRulesBuilderRulesV20230920CriterionEcmdUsername
    This criterion can be used in includes.
    edge_workers_failure GetPropertyRulesBuilderRulesV20230920CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    file_extension GetPropertyRulesBuilderRulesV20230920CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20230920CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20230920CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    match_advanced GetPropertyRulesBuilderRulesV20230920CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    match_cp_code GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    match_response_code GetPropertyRulesBuilderRulesV20230920CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    match_variable GetPropertyRulesBuilderRulesV20230920CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadata_stage GetPropertyRulesBuilderRulesV20230920CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    origin_timeout GetPropertyRulesBuilderRulesV20230920CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20230920CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    query_string_parameter GetPropertyRulesBuilderRulesV20230920CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20230920CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recovery_config GetPropertyRulesBuilderRulesV20230920CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regular_expression GetPropertyRulesBuilderRulesV20230920CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    request_cookie GetPropertyRulesBuilderRulesV20230920CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    request_header GetPropertyRulesBuilderRulesV20230920CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    request_method GetPropertyRulesBuilderRulesV20230920CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    request_protocol GetPropertyRulesBuilderRulesV20230920CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    request_type GetPropertyRulesBuilderRulesV20230920CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    response_header GetPropertyRulesBuilderRulesV20230920CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    server_location GetPropertyRulesBuilderRulesV20230920CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20230920CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    token_authorization GetPropertyRulesBuilderRulesV20230920CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    user_agent GetPropertyRulesBuilderRulesV20230920CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    user_location GetPropertyRulesBuilderRulesV20230920CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    user_network GetPropertyRulesBuilderRulesV20230920CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variable_error GetPropertyRulesBuilderRulesV20230920CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtual_waiting_room_request GetPropertyRulesBuilderRulesV20230920CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitor_prioritization_request GetPropertyRulesBuilderRulesV20230920CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch Property Map
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket Property Map
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability Property Map
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion Property Map
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate Property Map
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp Property Map
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion Property Map
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin Property Map
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork Property Map
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType Property Map
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic Property Map
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups Property Map
    This criterion can be used in includes.
    ecmdAuthScheme Property Map
    This criterion can be used in includes.
    ecmdIsAuthenticated Property Map
    This criterion can be used in includes.
    ecmdUsername Property Map
    This criterion can be used in includes.
    edgeWorkersFailure Property Map
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension Property Map
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename Property Map
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname Property Map
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced Property Map
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode Property Map
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode Property Map
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable Property Map
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage Property Map
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout Property Map
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path Property Map
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter Property Map
    Matches query string field names or values. This criterion can be used in includes.
    random Property Map
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig Property Map
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression Property Map
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie Property Map
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod Property Map
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol Property Map
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType Property Map
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation Property Map
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time Property Map
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization Property Map
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent Property Map
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation Property Map
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork Property Map
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError Property Map
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest Property Map
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest Property Map
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.

    GetPropertyRulesBuilderRulesV20230920CriterionAdvancedImMatch

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the match's scope.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the match's scope.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionBucket

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage Integer
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage number
    Specifies the percentage of requests to match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage int
    Specifies the percentage of requests to match.
    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.
    percentage Number
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionCacheability

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    match_operator str
    Specifies the match's logic.
    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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_CACHE).

    GetPropertyRulesBuilderRulesV20230920CriterionChinaCdnRegion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionClientCertificate

    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforce_mtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    is_certificate_present bool
    Executes rule behaviors only if a client certificate authenticates requests.
    is_certificate_valid str
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked bool
    Indicates that your 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.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionClientIp

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    IP or CIDR block, for example: 71.92.0.0/14.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    useHeaders boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked bool
    Indicates 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_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    template_uuid str
    This option is for internal usage only.
    use_headers bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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.
    values Sequence[str]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.

    GetPropertyRulesBuilderRulesV20230920CriterionClientIpVersion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    useXForwardedFor boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked bool
    Indicates that your 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_x_forwarded_for bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.

    GetPropertyRulesBuilderRulesV20230920CriterionCloudletsOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The Cloudlets Origins identifier, limited to alphanumeric and underscore 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionContentDeliveryNetwork

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network string
    Match the network.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network str
    Match the network.
    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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionContentType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Content-Type response header value, for example text/html.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for all values.
    matchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Content-Type response header value, for example text/html.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for all values.
    match_operator str
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    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.
    values Sequence[str]
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.

    GetPropertyRulesBuilderRulesV20230920CriterionDeviceCharacteristic

    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues List<string>
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues []string
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Integer
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic string
    Aspect of the device or browser 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.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues string[]
    When the characteristic expects a string, this specifies the set of values.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue string
    When the characteristic expects a version number, this specifies it as a string.
    boolean_value bool
    When the characteristic expects a boolean value, this specifies the value.
    characteristic str
    Aspect of the device or browser 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_case_sensitive bool
    Sets a case-sensitive match for the stringValue field.
    match_wildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numeric_match_operator str
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numeric_value int
    When the characteristic expects a numeric value, this specifies the number.
    string_match_operator str
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    string_values Sequence[str]
    When the characteristic expects a string, this specifies the set of values.
    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.
    version_match_operator str
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    version_value str
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.

    GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthGroups

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked bool
    Indicates 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_operator 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.
    value str
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230920CriterionEcmdAuthScheme

    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    auth_scheme 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.
    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.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionEcmdIsAuthenticated

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionEcmdUsername

    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    match_operator 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.
    value str
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20230920CriterionEdgeWorkersFailure

    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus string
    Specify execution status.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    exec_status str
    Specify execution status.
    locked bool
    Indicates that your 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.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionFileExtension

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.

    GetPropertyRulesBuilderRulesV20230920CriterionFilename

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the values field.
    matchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the values field.
    match_operator str
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    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.
    values Sequence[str]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.

    GetPropertyRulesBuilderRulesV20230920CriterionHostname

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked bool
    Indicates 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_operator str
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.

    GetPropertyRulesBuilderRulesV20230920CriterionMatchAdvanced

    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml string
    An XML string that closes the relevant block.
    description string
    A 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.
    openXml string
    An XML string that opens the relevant block.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    close_xml str
    An XML string that closes the relevant block.
    description str
    A 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.
    open_xml str
    An XML string that opens the relevant block.
    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.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to match the CP code, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20230920CriterionMatchCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20230920CriterionMatchResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A set of response codes to match, for example ["404","500"].
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator string
    Matches numeric range or a specified set of values.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A set of response codes to match, for example ["404","500"].
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    match_operator str
    Matches numeric range or a specified set of values.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    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.
    values Sequence[str]
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].

    GetPropertyRulesBuilderRulesV20230920CriterionMatchVariable

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues List<string>
    Specifies an array of matching strings.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues []string
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound string
    Specifies the range's numeric minimum value.
    matchCaseSensitive boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound string
    Specifies the range's numeric maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression string
    Specifies a single matching string.
    variableName string
    The name of the variable to match.
    variableValues string[]
    Specifies an array of matching strings.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound str
    Specifies the range's numeric minimum value.
    match_case_sensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    match_operator str
    The type of match, based on which you use different options to specify the match criteria.
    match_wildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound str
    Specifies the range's numeric maximum value.
    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_expression str
    Specifies a single matching string.
    variable_name str
    The name of the variable to match.
    variable_values Sequence[str]
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.

    GetPropertyRulesBuilderRulesV20230920CriterionMetadataStage

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Compares the current rule with the specified metadata stage.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked bool
    Indicates 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_operator str
    Compares the current rule with the specified metadata stage.
    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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.

    GetPropertyRulesBuilderRulesV20230920CriterionOriginTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specifies a single required ORIGIN_TIMED_OUT 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionPath

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of the values array.
    normalize boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of the values array.
    normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    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.
    values Sequence[str]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.

    GetPropertyRulesBuilderRulesV20230920CriterionQueryStringParameter

    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The value of the query field, for example, string in ?q=string.
    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.
    escapeValue boolean
    Matches when the value is URL-escaped.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName string
    The name of the query field, for example, q in ?q=string.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The value of the query field, for example, string in ?q=string.
    escape_value bool
    Matches when the value is URL-escaped.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the parameterName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameter_name str
    The name of the query field, for example, q in ?q=string.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.

    GetPropertyRulesBuilderRulesV20230920CriterionRandom

    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket Integer
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    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.
    bucket Number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionRecoveryConfig

    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    config_name str
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked bool
    Indicates that your 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.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionRegularExpression

    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive boolean
    Sets a case-sensitive regular expression 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.
    matchString string
    The string to match, typically the contents of a dynamic variable.
    regex string
    The regular expression (PCRE) to match against the string.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    case_sensitive bool
    Sets a case-sensitive regular expression 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_string str
    The string to match, typically the contents of a dynamic variable.
    regex str
    The regular expression (PCRE) to match against the string.
    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.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionRequestCookie

    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookie_name str
    The name of the cookie, for example, visitor in visitor:anon.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the cookieName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.

    GetPropertyRulesBuilderRulesV20230920CriterionRequestHeader

    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName string
    The name of the request header, for example Accept-Language.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    header_name str
    The name of the request header, for example Accept-Language.
    locked bool
    Indicates 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_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more 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.
    values Sequence[str]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.

    GetPropertyRulesBuilderRulesV20230920CriterionRequestMethod

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked bool
    Indicates 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_operator str
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.

    GetPropertyRulesBuilderRulesV20230920CriterionRequestProtocol

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked bool
    Indicates that your 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.

    GetPropertyRulesBuilderRulesV20230920CriterionRequestType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked bool
    Indicates 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_operator str
    Specifies whether the request IS or IS_NOT the type of specified 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.
    value str
    Specifies the type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.

    GetPropertyRulesBuilderRulesV20230920CriterionResponseHeader

    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName string
    The name of the response header, for example Content-Type.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator string
    Narrows the match according to various criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    header_name str
    The name of the response header, for example Content-Type.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_value bool
    When enabled, the match is case-sensitive for the value field.
    match_operator str
    Narrows the match according to various criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.

    GetPropertyRulesBuilderRulesV20230920CriterionServerLocation

    Continents List<string>
    Continent codes.
    Countries List<string>
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Continents []string
    Continent codes.
    Countries []string
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents string[]
    Continent codes.
    countries string[]
    ISO 3166-1 country codes, such as US or CN.
    locationType string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents Sequence[str]
    Continent codes.
    countries Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    location_type str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    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.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionTime

    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate string
    Sets the start of a time period.
    endDate string
    Sets the end of a fixed time period.
    lastingDate string
    Sets the start of a fixed time period.
    lastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies how to define the range of time.
    repeatBeginDate string
    Sets the start of the initial time period.
    repeatDuration string
    Sets the duration of each repeating time period.
    repeatInterval string
    Sets the time between each repeating time period's starting points.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    apply_daylight_savings_time bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    begin_date str
    Sets the start of a time period.
    end_date str
    Sets the end of a fixed time period.
    lasting_date str
    Sets the start of a fixed time period.
    lasting_duration str
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked bool
    Indicates 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_operator str
    Specifies how to define the range of time.
    repeat_begin_date str
    Sets the start of the initial time period.
    repeat_duration str
    Sets the duration of each repeating time period.
    repeat_interval str
    Sets the time between each repeating time period's starting points.
    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.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionTokenAuthorization

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Error match scope.
    StatusLists List<string>
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Error match scope.
    StatusLists []string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Error match scope.
    statusLists string[]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Error match scope.
    status_lists Sequence[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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionUserAgent

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    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.
    values Sequence[str]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).

    GetPropertyRulesBuilderRulesV20230920CriterionUserLocation

    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues List<string>
    Continent codes.
    CountryValues List<string>
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues []string
    Continent codes.
    CountryValues []string
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps string
    Specifies which IP addresses determine the user's location.
    continentValues string[]
    Continent codes.
    countryValues string[]
    ISO 3166-1 country codes, such as US or CN.
    field string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    check_ips str
    Specifies which IP addresses determine the user's location.
    continent_values Sequence[str]
    Continent codes.
    country_values Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    field str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    region_values Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionUserNetwork

    BandwidthValues List<string>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues List<string>
    NetworkValues List<string>
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BandwidthValues []string
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues []string
    NetworkValues []string
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues string[]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps string
    Specifies which IP addresses determine the user's network.
    field string
    The type of information 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.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues string[]
    networkValues string[]
    Any set of specific networks.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidth_values Sequence[str]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    check_ips str
    Specifies which IP addresses determine the user's network.
    field str
    The type of information 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    network_type_values Sequence[str]
    network_values Sequence[str]
    Any set of specific networks.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionVariableError

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames List<string>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames []string
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames string[]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    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_names Sequence[str]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.

    GetPropertyRulesBuilderRulesV20230920CriterionVirtualWaitingRoomRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CriterionVisitorPrioritizationRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20230920CustomOverride

    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override
    name string
    The name of a custom override
    overrideId string
    The ID of a custom override
    name str
    The name of a custom override
    override_id str
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override

    GetPropertyRulesBuilderRulesV20230920Variable

    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable
    description string
    The description for a variable
    hidden boolean
    Whether a variable should be hidden
    name string
    The name of a variable
    sensitive boolean
    States whether a variable contains sensitive information
    value string
    The value for a variable
    description str
    The description for a variable
    hidden bool
    Whether a variable should be hidden
    name str
    The name of a variable
    sensitive bool
    States whether a variable contains sensitive information
    value str
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable

    GetPropertyRulesBuilderRulesV20231030

    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors List<GetPropertyRulesBuilderRulesV20231030Behavior>
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions List<GetPropertyRulesBuilderRulesV20231030Criterion>
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20231030CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables List<GetPropertyRulesBuilderRulesV20231030Variable>
    A list of variables for a rule
    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors []GetPropertyRulesBuilderRulesV20231030Behavior
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions []GetPropertyRulesBuilderRulesV20231030Criterion
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20231030CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables []GetPropertyRulesBuilderRulesV20231030Variable
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride String
    XML metadata of the rule
    behaviors List<GetPropertyRulesBuilderRulesV20231030Behavior>
    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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<GetPropertyRulesBuilderRulesV20231030Criterion>
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20231030CustomOverride
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid String
    The UUID of a rule template
    uuid String
    The UUID of the rule
    variables List<GetPropertyRulesBuilderRulesV20231030Variable>
    A list of variables for a rule
    name string
    The name of a rule
    advancedOverride string
    XML metadata of the rule
    behaviors GetPropertyRulesBuilderRulesV20231030Behavior[]
    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
    criteriaLocked boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    criterions GetPropertyRulesBuilderRulesV20231030Criterion[]
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20231030CustomOverride
    XML metadata of the rule
    isSecure boolean
    States whether a rule is secure
    templateLink string
    The template link for the rule
    templateUuid string
    The UUID of a rule template
    uuid string
    The UUID of the rule
    variables GetPropertyRulesBuilderRulesV20231030Variable[]
    A list of variables for a rule
    name str
    The name of a rule
    advanced_override str
    XML metadata of the rule
    behaviors Sequence[GetPropertyRulesBuilderRulesV20231030Behavior]
    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_satisfy str
    States whether 'all' criteria need to match or 'any'
    criterions Sequence[GetPropertyRulesBuilderRulesV20231030Criterion]
    The list of criteria for a rule
    custom_override GetPropertyRulesBuilderRulesV20231030CustomOverride
    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[GetPropertyRulesBuilderRulesV20231030Variable]
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride 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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<Property Map>
    The list of criteria for a rule
    customOverride Property Map
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid 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

    GetPropertyRulesBuilderRulesV20231030Behavior

    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20231030BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20231030BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20231030BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20231030BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20231030BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20231030BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20231030BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20231030BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20231030BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20231030BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20231030BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20231030BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20231030BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20231030BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20231030BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20231030BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20231030BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20231030BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20231030BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20231030BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20231030BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20231030BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20231030BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20231030BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20231030BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20231030BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20231030BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20231030BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20231030BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20231030BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20231030BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20231030BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20231030BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20231030BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20231030BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20231030BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20231030BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20231030BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20231030BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20231030BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20231030BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20231030BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20231030BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20231030BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20231030BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20231030BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20231030BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20231030BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20231030BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20231030BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20231030BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20231030BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20231030BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20231030BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20231030BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20231030BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20231030BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20231030BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20231030BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20231030BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20231030BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20231030BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20231030BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20231030BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20231030BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20231030BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20231030BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20231030BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20231030BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20231030BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20231030BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20231030BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20231030BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20231030BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20231030BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20231030BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20231030BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20231030BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20231030BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20231030BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20231030BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20231030BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20231030BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20231030BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20231030BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20231030BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20231030BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20231030BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20231030BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20231030BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20231030BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20231030BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20231030BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20231030BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20231030BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20231030BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20231030BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20231030BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20231030BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20231030BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20231030BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20231030BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20231030BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20231030BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20231030BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20231030BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20231030BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20231030BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20231030BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20231030BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20231030BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20231030BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20231030BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20231030BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20231030BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20231030BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20231030BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20231030BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20231030BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20231030BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20231030BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20231030BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20231030BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20231030BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20231030BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20231030BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20231030BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20231030BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20231030BehaviorWebdav
    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.
    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20231030BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20231030BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20231030BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20231030BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20231030BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20231030BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20231030BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20231030BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20231030BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20231030BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20231030BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20231030BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20231030BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20231030BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20231030BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20231030BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20231030BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20231030BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20231030BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20231030BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20231030BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20231030BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20231030BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20231030BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20231030BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20231030BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20231030BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20231030BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20231030BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20231030BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20231030BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20231030BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20231030BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20231030BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20231030BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20231030BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20231030BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20231030BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20231030BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20231030BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20231030BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20231030BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20231030BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20231030BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20231030BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20231030BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20231030BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20231030BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20231030BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20231030BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20231030BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20231030BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20231030BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20231030BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20231030BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20231030BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20231030BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20231030BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20231030BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20231030BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20231030BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20231030BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20231030BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20231030BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20231030BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20231030BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20231030BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20231030BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20231030BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20231030BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20231030BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20231030BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20231030BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20231030BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20231030BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20231030BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20231030BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20231030BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20231030BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20231030BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20231030BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20231030BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20231030BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20231030BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20231030BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20231030BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20231030BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20231030BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20231030BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20231030BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20231030BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20231030BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20231030BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20231030BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20231030BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20231030BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20231030BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20231030BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20231030BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20231030BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20231030BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20231030BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20231030BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20231030BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20231030BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20231030BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20231030BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20231030BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20231030BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20231030BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20231030BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20231030BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20231030BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20231030BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20231030BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20231030BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20231030BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20231030BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20231030BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20231030BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20231030BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20231030BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20231030BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20231030BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20231030BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20231030BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20231030BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20231030BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20231030BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20231030BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20231030BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20231030BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20231030BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20231030BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20231030BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20231030BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20231030BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20231030BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20231030BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20231030BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20231030BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20231030BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20231030BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20231030BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20231030BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20231030BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20231030BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20231030BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20231030BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20231030BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20231030BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20231030BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20231030BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20231030BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20231030BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20231030BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20231030BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20231030BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20231030BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20231030BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20231030BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20231030BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20231030BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20231030BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20231030BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20231030BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20231030BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20231030BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20231030BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20231030BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20231030BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20231030BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20231030BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20231030BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20231030BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20231030BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20231030BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20231030BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20231030BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20231030BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20231030BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20231030BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20231030BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20231030BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20231030BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20231030BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20231030BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20231030BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20231030BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20231030BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20231030BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20231030BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20231030BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20231030BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20231030BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20231030BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20231030BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20231030BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20231030BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20231030BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20231030BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20231030BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20231030BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20231030BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20231030BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20231030BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20231030BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20231030BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20231030BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20231030BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20231030BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20231030BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20231030BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20231030BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20231030BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20231030BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20231030BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20231030BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20231030BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20231030BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20231030BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20231030BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20231030BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20231030BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20231030BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20231030BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20231030BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20231030BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20231030BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20231030BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20231030BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20231030BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20231030BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20231030BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20231030BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20231030BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20231030BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20231030BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20231030BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20231030BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20231030BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20231030BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20231030BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20231030BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20231030BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20231030BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20231030BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20231030BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20231030BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20231030BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20231030BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20231030BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20231030BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20231030BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20231030BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20231030BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20231030BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20231030BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20231030BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20231030BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20231030BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20231030BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20231030BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20231030BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20231030BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20231030BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20231030BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20231030BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20231030BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20231030BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20231030BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20231030BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20231030BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20231030BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20231030BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20231030BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20231030BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20231030BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20231030BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20231030BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20231030BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20231030BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20231030BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20231030BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20231030BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20231030BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20231030BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20231030BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20231030BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20231030BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20231030BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20231030BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20231030BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20231030BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20231030BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20231030BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20231030BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20231030BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20231030BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20231030BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20231030BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20231030BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20231030BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20231030BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20231030BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20231030BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20231030BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20231030BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20231030BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20231030BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20231030BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20231030BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20231030BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20231030BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20231030BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20231030BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20231030BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20231030BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20231030BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20231030BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20231030BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20231030BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20231030BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20231030BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20231030BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20231030BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20231030BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20231030BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20231030BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20231030BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20231030BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20231030BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20231030BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20231030BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20231030BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20231030BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20231030BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20231030BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20231030BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20231030BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20231030BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20231030BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20231030BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20231030BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20231030BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20231030BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20231030BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20231030BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20231030BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20231030BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20231030BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20231030BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20231030BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20231030BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20231030BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20231030BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20231030BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20231030BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20231030BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20231030BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20231030BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20231030BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20231030BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20231030BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20231030BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20231030BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20231030BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20231030BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20231030BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20231030BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20231030BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20231030BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20231030BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20231030BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20231030BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20231030BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20231030BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20231030BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20231030BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20231030BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20231030BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20231030BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20231030BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20231030BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20231030BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20231030BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20231030BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20231030BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20231030BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20231030BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20231030BehaviorWebdav
    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_circuit_breaker GetPropertyRulesBuilderRulesV20231030BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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 GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptive_image_compression GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20231030BehaviorAdvanced
    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 GetPropertyRulesBuilderRulesV20231030BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizer_tag GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizerTag
    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_in_cache_hierarchy GetPropertyRulesBuilderRulesV20231030BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allow_cloudlets_origins GetPropertyRulesBuilderRulesV20231030BehaviorAllowCloudletsOrigins
    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 GetPropertyRulesBuilderRulesV20231030BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_https_cache_key_sharing GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allow_https_downgrade GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsDowngrade
    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 GetPropertyRulesBuilderRulesV20231030BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allow_patch GetPropertyRulesBuilderRulesV20231030BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_post GetPropertyRulesBuilderRulesV20231030BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_put GetPropertyRulesBuilderRulesV20231030BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allow_transfer_encoding GetPropertyRulesBuilderRulesV20231030BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    alt_svc_header GetPropertyRulesBuilderRulesV20231030BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    api_prioritization GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    application_load_balancer GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancer
    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 GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentation
    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_validation GetPropertyRulesBuilderRulesV20231030BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    base_directory GetPropertyRulesBuilderRulesV20231030BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    boss_beaconing GetPropertyRulesBuilderRulesV20231030BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20231030BehaviorBreadcrumbs
    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 GetPropertyRulesBuilderRulesV20231030BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20231030BehaviorBrotli
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cache_id GetPropertyRulesBuilderRulesV20231030BehaviorCacheId
    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_ignore_case GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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_query_params GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyQueryParams
    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_rewrite GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyRewrite
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCachePost
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCacheRedirect
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCacheTag
    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. The cacheTag 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_visible GetPropertyRulesBuilderRulesV20231030BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20231030BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    central_authorization GetPropertyRulesBuilderRulesV20231030BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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 GetPropertyRulesBuilderRulesV20231030BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    client_certificate_auth GetPropertyRulesBuilderRulesV20231030BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    client_characteristics GetPropertyRulesBuilderRulesV20231030BehaviorClientCharacteristics
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCloudInterconnects
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloud_wrapper_advanced GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapperAdvanced
    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.
    common_media_client_data GetPropertyRulesBuilderRulesV20231030BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditional_origin GetPropertyRulesBuilderRulesV20231030BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    construct_response GetPropertyRulesBuilderRulesV20231030BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    content_characteristics GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristics
    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_amd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsAmd
    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_dd GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsDd
    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_wsd_large_file GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLargeFile
    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_wsd_live GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLive
    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_wsd_vod GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdVod
    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_position GetPropertyRulesBuilderRulesV20231030BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    content_targeting_protection GetPropertyRulesBuilderRulesV20231030BehaviorContentTargetingProtection
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCorsSupport
    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 GetPropertyRulesBuilderRulesV20231030BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    custom_behavior GetPropertyRulesBuilderRulesV20231030BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20231030BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20231030BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcp_auth_hmac_transformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_regex_transformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_substring_transformation GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_variable_extractor GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthVariableExtractor
    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_authz_groups GetPropertyRulesBuilderRulesV20231030BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcp_dev_relations GetPropertyRulesBuilderRulesV20231030BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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_time_auth GetPropertyRulesBuilderRulesV20231030BehaviorDcpRealTimeAuth
    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 GetPropertyRulesBuilderRulesV20231030BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    deny_access GetPropertyRulesBuilderRulesV20231030BehaviorDenyAccess
    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_failover_access GetPropertyRulesBuilderRulesV20231030BehaviorDenyDirectFailoverAccess
    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_cache_id GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicCacheId
    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_header GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dns_async_refresh GetPropertyRulesBuilderRulesV20231030BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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 GetPropertyRulesBuilderRulesV20231030BehaviorDnsPrefresh
    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 GetPropertyRulesBuilderRulesV20231030BehaviorDowngradeProtocol
    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_marker GetPropertyRulesBuilderRulesV20231030BehaviorDownloadCompleteMarker
    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 GetPropertyRulesBuilderRulesV20231030BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstream_cache GetPropertyRulesBuilderRulesV20231030BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamic_throughtput_optimization GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimization
    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_optimization_override GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimizationOverride
    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_content GetPropertyRulesBuilderRulesV20231030BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecms_bulk_upload GetPropertyRulesBuilderRulesV20231030BehaviorEcmsBulkUpload
    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 GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecms_dataset GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDataset
    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_key GetPropertyRulesBuilderRulesV20231030BehaviorEcmsObjectKey
    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 GetPropertyRulesBuilderRulesV20231030BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edge_load_balancing_advanced GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingAdvanced
    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_balancing_data_center GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenter
    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_balancing_origin GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingOrigin
    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.
    edge_origin_authorization GetPropertyRulesBuilderRulesV20231030BehaviorEdgeOriginAuthorization
    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 GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edge_scape GetPropertyRulesBuilderRulesV20231030BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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_includes GetPropertyRulesBuilderRulesV20231030BehaviorEdgeSideIncludes
    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, or filename. 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 GetPropertyRulesBuilderRulesV20231030BehaviorEdgeWorker
    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.
    enforce_mtls_settings GetPropertyRulesBuilderRulesV20231030BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhanced_akamai_protocol GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedAkamaiProtocol
    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_detection GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedProxyDetection
    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_header_enrichment GetPropertyRulesBuilderRulesV20231030BehaviorEpdForwardHeaderEnrichment
    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 GetPropertyRulesBuilderRulesV20231030BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failover_bot_manager_feature_compatibility GetPropertyRulesBuilderRulesV20231030BehaviorFailoverBotManagerFeatureCompatibility
    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 GetPropertyRulesBuilderRulesV20231030BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20231030BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    first_party_marketing GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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_marketing_plus GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing 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 GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20231030BehaviorG2oheader
    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_number GetPropertyRulesBuilderRulesV20231030BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphql_caching GetPropertyRulesBuilderRulesV20231030BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzip_response GetPropertyRulesBuilderRulesV20231030BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hd_data_advanced GetPropertyRulesBuilderRulesV20231030BehaviorHdDataAdvanced
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHealthDetection
    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_binding GetPropertyRulesBuilderRulesV20231030BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20231030BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    http_strict_transport_security GetPropertyRulesBuilderRulesV20231030BehaviorHttpStrictTransportSecurity
    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_https_upgrade GetPropertyRulesBuilderRulesV20231030BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    im_override GetPropertyRulesBuilderRulesV20231030BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    image_and_video_manager GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManager
    This behavior can be used in includes.
    image_manager GetPropertyRulesBuilderRulesV20231030BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    image_manager_video GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20231030BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20231030BehaviorInstant
    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 GetPropertyRulesBuilderRulesV20231030BehaviorInstantConfig
    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_optimization GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    large_file_optimization_advanced GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limit_bit_rate GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    log_custom GetPropertyRulesBuilderRulesV20231030BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    m_pulse GetPropertyRulesBuilderRulesV20231030BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifest_personalization GetPropertyRulesBuilderRulesV20231030BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifest_rerouting GetPropertyRulesBuilderRulesV20231030BehaviorManifestRerouting
    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_push GetPropertyRulesBuilderRulesV20231030BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    media_acceleration GetPropertyRulesBuilderRulesV20231030BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    media_acceleration_quic_optout GetPropertyRulesBuilderRulesV20231030BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    media_client GetPropertyRulesBuilderRulesV20231030BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    media_file_retrieval_optimization GetPropertyRulesBuilderRulesV20231030BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    media_origin_failover GetPropertyRulesBuilderRulesV20231030BehaviorMediaOriginFailover
    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 GetPropertyRulesBuilderRulesV20231030BehaviorMetadataCaching
    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_performance GetPropertyRulesBuilderRulesV20231030BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modify_incoming_request_header GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modify_incoming_response_header GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modify_outgoing_request_header GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modify_outgoing_response_header GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modify_via_header GetPropertyRulesBuilderRulesV20231030BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20231030BehaviorOrigin
    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 GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristics
    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_wsd GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    origin_failure_recovery_method GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    origin_failure_recovery_policy GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    origin_ip_acl GetPropertyRulesBuilderRulesV20231030BehaviorOriginIpAcl
    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.
    permissions_policy GetPropertyRulesBuilderRulesV20231030BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistent_client_connection GetPropertyRulesBuilderRulesV20231030BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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 GetPropertyRulesBuilderRulesV20231030BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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_information GetPropertyRulesBuilderRulesV20231030BehaviorPersonallyIdentifiableInformation
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20231030BehaviorPreconnect
    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_delivery GetPropertyRulesBuilderRulesV20231030BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictive_prefetching GetPropertyRulesBuilderRulesV20231030BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20231030BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefresh_cache GetPropertyRulesBuilderRulesV20231030BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20231030BehaviorQuality
    This behavior can be used in includes.
    quic_beta GetPropertyRulesBuilderRulesV20231030BehaviorQuicBeta
    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 GetPropertyRulesBuilderRulesV20231030BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20231030BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    read_timeout GetPropertyRulesBuilderRulesV20231030BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    real_time_reporting GetPropertyRulesBuilderRulesV20231030BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    real_user_monitoring GetPropertyRulesBuilderRulesV20231030BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20231030BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20231030BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    referer_checking GetPropertyRulesBuilderRulesV20231030BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    remove_query_parameter GetPropertyRulesBuilderRulesV20231030BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    remove_vary GetPropertyRulesBuilderRulesV20231030BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20231030BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    request_client_hints GetPropertyRulesBuilderRulesV20231030BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    request_control GetPropertyRulesBuilderRulesV20231030BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    request_type_marker GetPropertyRulesBuilderRulesV20231030BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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 GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resource_optimizer_extended_compatibility GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizerExtendedCompatibility
    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 GetPropertyRulesBuilderRulesV20231030BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    response_cookie GetPropertyRulesBuilderRulesV20231030BehaviorResponseCookie
    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_caching GetPropertyRulesBuilderRulesV20231030BehaviorRestrictObjectCaching
    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_status GetPropertyRulesBuilderRulesV20231030BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewrite_url GetPropertyRulesBuilderRulesV20231030BehaviorRewriteUrl
    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 GetPropertyRulesBuilderRulesV20231030BehaviorRumCustom
    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 GetPropertyRulesBuilderRulesV20231030BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    sales_force_commerce_cloud_client GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudClient
    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_commerce_cloud_provider GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    sales_force_commerce_cloud_provider_host_header GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    save_post_dca_processing GetPropertyRulesBuilderRulesV20231030BehaviorSavePostDcaProcessing
    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 GetPropertyRulesBuilderRulesV20231030BehaviorScheduleInvalidation
    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 GetPropertyRulesBuilderRulesV20231030BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmented_content_protection GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmented_media_optimization GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmented_media_streaming_prefetch GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaStreamingPrefetch
    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 GetPropertyRulesBuilderRulesV20231030BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulate_error_code GetPropertyRulesBuilderRulesV20231030BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    site_shield GetPropertyRulesBuilderRulesV20231030BehaviorSiteShield
    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_migration GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standard_tls_migration_override GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigrationOverride
    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_parsing GetPropertyRulesBuilderRulesV20231030BehaviorStrictHeaderParsing
    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 GetPropertyRulesBuilderRulesV20231030BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sure_route GetPropertyRulesBuilderRulesV20231030BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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 GetPropertyRulesBuilderRulesV20231030BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    tea_leaf GetPropertyRulesBuilderRulesV20231030BehaviorTeaLeaf
    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 GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistribution
    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 the cache 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_advanced GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tiered_distribution_customization GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20231030BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uid_configuration GetPropertyRulesBuilderRulesV20231030BehaviorUidConfiguration
    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_tag GetPropertyRulesBuilderRulesV20231030BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verify_json_web_token GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verify_json_web_token_for_dcp GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verify_token_authorization GetPropertyRulesBuilderRulesV20231030BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtual_waiting_room GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtual_waiting_room_with_edge_workers GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoomWithEdgeWorkers
    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 GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo_standalone GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20231030BehaviorWatermarking
    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_firewall GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewall
    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 GetPropertyRulesBuilderRulesV20231030BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20231030BehaviorWebdav
    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.
    adScalerCircuitBreaker Property Map
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration 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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression Property Map
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. 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.
    aggregatedReporting Property Map
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. 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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag 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.
    allHttpInCacheHierarchy Property Map
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins Property Map
    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.
    allowDelete 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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing Property Map
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade Property Map
    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.
    allowOptions 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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch 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, and allowPut behaviors. This behavior can be used in includes.
    allowPost 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, and allowPut behaviors. This behavior can be used in includes.
    allowPut 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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding Property Map
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader Property Map
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization 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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer Property Map
    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.
    audienceSegmentation 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.
    autoDomainValidation Property Map
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory Property Map
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing 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.
    breadcrumbs 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.
    breakConnection 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.
    cacheError 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, and 505. This behavior can be used in includes.
    cacheId 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.
    cacheKeyIgnoreCase Property Map
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams Property Map
    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.
    cacheKeyRewrite Property Map
    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.
    cachePost 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.
    cacheRedirect 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.
    cacheTag 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. The cacheTag 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.
    cacheTagVisible Property Map
    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 the modifyOutgoingResponseHeader 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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization 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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects Property Map
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth Property Map
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics 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.
    cloudInterconnects 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.
    cloudWrapper 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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced Property Map
    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.
    commonMediaClientData Property Map
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin Property Map
    This behavior cannot be used in includes.
    constructResponse 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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics 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.
    contentCharacteristicsAmd 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.
    contentCharacteristicsDd 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.
    contentCharacteristicsWsdLargeFile Property Map
    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.
    contentCharacteristicsWsdLive Property Map
    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.
    contentCharacteristicsWsdVod Property Map
    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.
    contentPrePosition Property Map
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection Property Map
    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.
    corsSupport 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.
    cpCode 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 the List CP codes operation. This behavior can be used in includes.
    customBehavior 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 relevant behaviorId value from the response within the current customBehavior. See Custom 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 the DataStream 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. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor Property Map
    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.
    dcpDefaultAuthzGroups Property Map
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations Property Map
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth Property Map
    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.
    deliveryReceipt 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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess 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.
    denyDirectFailoverAccess Property Map
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId Property Map
    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.
    deviceCharacteristicHeader Property Map
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh Property Map
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh 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.
    downgradeProtocol 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.
    downloadCompleteMarker 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 logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes.
    downloadNotification 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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache 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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization Property Map
    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.
    dynamicThroughtputOptimizationOverride Property Map
    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.
    dynamicWebContent Property Map
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload Property Map
    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.
    ecmsDatabase 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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset 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.
    ecmsObjectKey Property Map
    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.
    edgeConnect Property Map
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced Property Map
    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.
    edgeLoadBalancingDataCenter Property Map
    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.
    edgeLoadBalancingOrigin Property Map
    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.
    edgeOriginAuthorization 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.
    edgeRedirector Property Map
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape 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 special X-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.
    edgeSideIncludes Property Map
    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, or filename. 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.
    edgeWorker 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.
    enforceMtlsSettings Property Map
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol Property Map
    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.
    enhancedProxyDetection Property Map
    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.
    epdForwardHeaderEnrichment Property Map
    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.
    failAction 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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility Property Map
    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.
    fastInvalidate Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips Property Map
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing Property Map
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus Property Map
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite 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 within Control Center, or use the Cloudlets API to configure it programmatically. 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.
    globalRequestNumber Property Map
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching Property Map
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse 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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced Property Map
    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.
    healthDetection 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.
    hsafEipBinding Property Map
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity Property Map
    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.
    httpToHttpsUpgrade Property Map
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride 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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager Property Map
    This behavior can be used in includes.
    imageManager 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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo Property Map
    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 a fileExtension. 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.
    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.
    instantConfig 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.
    largeFileOptimization Property Map
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced Property Map
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate Property Map
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom Property Map
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse Property Map
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization 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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting 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.
    manualServerPush Property Map
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration Property Map
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout Property Map
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization Property Map
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover Property Map
    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.
    metadataCaching 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.
    mobileSdkPerformance Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader Property Map
    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.
    originCharacteristics 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.
    originCharacteristicsWsd Property Map
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod Property Map
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy Property Map
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl Property Map
    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.
    permissionsPolicy Property Map
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection Property Map
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection Property Map
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation Property Map
    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.
    phasedRelease 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 within Control 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.
    predictiveContentDelivery Property Map
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching 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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache 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.
    quicBeta 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.
    randomSeek 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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout 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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting Property Map
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring Property Map
    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 on destinationHostname and destinationPath 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 use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking Property Map
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter Property Map
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary Property Map
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary 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.
    requestClientHints Property Map
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker Property Map
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility Property Map
    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.
    responseCode 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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie 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.
    restrictObjectCaching Property Map
    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.
    returnCacheStatus Property Map
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl 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.
    rumCustom 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.
    saasDefinitions Property Map
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient Property Map
    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.
    salesForceCommerceCloudProvider Property Map
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader Property Map
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing Property Map
    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.
    scheduleInvalidation 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.
    scriptManagement Property Map
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection Property Map
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization Property Map
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch Property Map
    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.
    setVariable 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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode Property Map
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield 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.
    standardTlsMigration Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride 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.
    strictHeaderParsing Property Map
    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.
    subCustomer 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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute Property Map
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf 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.
    tieredDistribution 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 the cache 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.
    tieredDistributionAdvanced 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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization Property Map
    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 enable cloudWrapper 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.
    uidConfiguration 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.
    validateEntityTag Property Map
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken Property Map
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp Property Map
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization Property Map
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom Property Map
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers Property Map
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization Property Map
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo Property Map
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone Property Map
    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.
    webApplicationFirewall Property Map
    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.
    webSockets 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorAdScalerCircuitBreaker

    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased string
    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.
    responseCodeBased boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased string
    Defines a custom error response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response_code_based str
    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_based bool
    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, or SPECIFY_YOUR_OWN for a custom code.
    response_delay_based bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    response_delay_threshold str
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    return_error_response_code_based str
    Specifies the error to include in the response to the client.
    specify_your_own_response_code_based str
    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.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveAcceleration

    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid string
    This option is for internal usage only.
    titleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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. See Add 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.
    cookie_name str
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enable_brotli_compression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enable_for_noncacheable bool
    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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring 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_server_push str
    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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorAdaptiveImageCompression

    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Integer
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Integer
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Integer
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Integer
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Integer
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Integer
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    compressMobile boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid string
    This option is for internal usage only.
    tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    tier1MobileCompressionValue number
    Specifies the compression percentage.
    tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue number
    Specifies the compression percentage.
    tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue number
    Specifies the compression percentage.
    tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue number
    Specifies the compression percentage.
    tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue number
    Specifies the compression percentage.
    tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue number
    Specifies the compression percentage.
    titleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    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_compression_method str
    Specifies tier-1 behavior.
    tier1_mobile_compression_value int
    Specifies the compression percentage.
    tier1_standard_compression_method str
    Specifies tier-1 non-cellular network behavior.
    tier1_standard_compression_value int
    Specifies the compression percentage.
    tier2_mobile_compression_method str
    Specifies tier-2 cellular-network behavior.
    tier2_mobile_compression_value int
    Specifies the compression percentage.
    tier2_standard_compression_method str
    Specifies tier-2 non-cellular network behavior.
    tier2_standard_compression_value int
    Specifies the compression percentage.
    tier3_mobile_compression_method str
    Specifies tier-3 cellular-network behavior.
    tier3_mobile_compression_value int
    Specifies the compression percentage.
    tier3_standard_compression_method str
    Specifies tier-3 non-cellular network behavior.
    tier3_standard_compression_value int
    Specifies the compression percentage.
    title_aic_mobile str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    title_aic_nonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Number
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Number
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Number
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Number
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Number
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Number
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorAggregatedReporting

    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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizer

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAkamaizerTag

    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname string
    Specifies the replacement hostname for the tag to use.
    scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    include_tags_attribute 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.
    tags_attribute 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.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllHttpInCacheHierarchy

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowCloudletsOrigins

    Enabled bool
    Allows you to assign custom origin definitions referenced in sub-rules by cloudletsOrigin labels. If disabled, all sub-rules are ignored.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory boolean
    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.
    purgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_directory bool
    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_query_parameter str
    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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowDelete

    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsCacheKeySharing

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowHttpsDowngrade

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowOptions

    Enabled bool
    Set this to true to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowPatch

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowPost

    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled boolean
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_content_length bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled 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.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowPut

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAllowTransferEncoding

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAltSvcHeader

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge Integer
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the Alt-Svc header. The default max-age for an Alt-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.
    maxAge Number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritization

    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    alternateResponseCacheTtl Integer
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Integer
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.
    alternateResponseCacheTtl number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid string
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode boolean
    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_cache_ttl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled bool
    Activates the API Prioritization feature.
    is_shared_policy 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.
    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 GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    net_storage_path str
    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_code GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttled_status_code int
    Specifies the HTTP response code for requests that receive the alternate response.
    use_throttled_cp_code bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    use_throttled_status_code bool
    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.
    alternateResponseCacheTtl Number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage Property Map
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode Property Map
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.

    GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancer

    AllDownNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps List<GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes List<string>
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllDownNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps []GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerFailoverOriginMap
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes []string
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Integer
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode string
    Determines what to do if an origin fails.
    failoverOriginMaps GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerFailoverOriginMap[]
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes string[]
    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.
    failoverTitle 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.
    originCookieName string
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration string
    Sets how long it is before the cookie expires.
    stickinessExpirationDate string
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_net_storage GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    all_down_net_storage_file str
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    all_down_status_code str
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    all_down_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_cache_prefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cached_content_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_policy GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Activates the Application Load Balancer Cloudlet.
    failover_attempts_threshold int
    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_maps Sequence[GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerFailoverOriginMap]
    Specifies a fixed set of failover mapping rules.
    failover_status_codes Sequence[str]
    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.
    origin_cookie_name str
    Specifies the name for your session cookie.
    specify_stickiness_cookie_domain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickiness_cookie_automatic_salt 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.
    stickiness_cookie_domain str
    Specifies the domain to track the stickiness cookie.
    stickiness_cookie_salt str
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickiness_cookie_set_http_only_flag bool
    Ensures the cookie is transmitted only over HTTP.
    stickiness_cookie_type 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_date str
    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.
    allDownNetStorage Property Map
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<Property Map>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerAllDownNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorApplicationLoadBalancerFailoverOriginMap

    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds List<string>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds []string
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds string[]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    from_origin_id str
    Specifies the origin whose failure triggers the mapping rule.
    to_origin_ids Sequence[str]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.

    GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentation

    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain string
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType string
    Specifies when the segmentation cookie expires.
    populationDuration string
    Specifies the lifetime of the segmentation cookie.
    populationRefresh boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    population_cookie_automatic_salt 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.
    population_cookie_domain str
    Specifies the domain to track the population cookie.
    population_cookie_include_rule_name bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    population_cookie_salt str
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    population_cookie_type 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.
    segment_tracking_cookie_name str
    This cookie name specifies the name of the segmentation rule.
    segment_tracking_custom_header str
    This custom HTTP header specifies the name of the segmentation rule.
    segment_tracking_method str
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segment_tracking_query_param str
    This query parameter specifies the name of the segmentation rule.
    segment_tracking_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specify_population_cookie_domain 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorAudienceSegmentationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorAutoDomainValidation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorBaseDirectory

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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/.

    GetPropertyRulesBuilderRulesV20231030BehaviorBossBeaconing

    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses List<string>
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses []string
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern string
    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.
    conditionalHttpStatuses string[]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency string
    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.
    forwardType 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.
    requestType string
    Specify when to trigger a beacon.
    samplingFrequency string
    Specifies a sampling frequency or disables beacons.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_pattern str
    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_statuses Sequence[str]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditional_sampling_frequency str
    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.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorBreadcrumbs

    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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 opposite ak-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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorBreakConnection

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorBrotli

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheError

    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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and 504 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 to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheId

    Elements List<string>
    Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    Specifies the name of the variable you want to include in the cache key.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyIgnoreCase

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyQueryParams

    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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheKeyRewrite

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey string
    Specifies the new cache key path as an alphanumeric value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCachePost

    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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    templateUuid string
    This option is for internal usage only.
    useBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheRedirect

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheTag

    Locked bool
    Indicates 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCacheTagVisible

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCaching

    Behavior string
    Specify the caching option.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    cacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl string
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache boolean
    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 live ttl to zero seconds.
    honorNoStore boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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_directives str
    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_support bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-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_age bool
    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 the max-age directive and the defaultTtl setting.
    honor_must_revalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honor_no_cache bool
    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 live ttl to zero seconds.
    honor_no_store bool
    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_revalidate bool
    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_maxage 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 the max-age directive and the defaultTtl 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.

    GetPropertyRulesBuilderRulesV20231030BehaviorCentralAuthorization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorChaseRedirects

    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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorClientCertificateAuth

    ClientCertificateAttributes List<string>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ClientCertificateAttributes []string
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes string[]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    client_certificate_attributes Sequence[str]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enable_client_certificate_validation_status bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enable_complete_client_certificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked bool
    Indicates that your 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.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorClientCharacteristics

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCloudInterconnects

    CloudLocations 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudLocations []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapper

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCloudWrapperAdvanced

    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_map str
    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.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCommonMediaClientData

    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_cmcd_segment_prefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked bool
    Indicates that your 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.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorConditionalOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorConstructResponse

    Body string
    HTML response of up to 2000 characters to send to the end-user client.
    Enabled bool
    Serves the custom response.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Integer
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode number
    The HTTP response code to send to the end-user client.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Number
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristics

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsAmd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom double
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom double
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom float64
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom float64
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Integer
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Integer
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Double
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Double
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationDashCustom number
    Customizes the number of seconds for the segment.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom number
    Customizes the number of seconds for the fragment.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationHlsCustom number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom number
    Customizes the number of seconds for the fragment.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_dash_custom int
    Customizes the number of seconds for the segment.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hds_custom int
    Customizes the number of seconds for the fragment.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_hls_custom float
    Customizes the number of seconds for the segment.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_duration_smooth_custom float
    Customizes the number of seconds for the fragment.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Number
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Number
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsDd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLargeFile

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdLive

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentCharacteristicsWsdVod

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentPrePosition

    Enabled bool
    Enables the Content PrePosition behavior.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation string
    sourceType string
    targets string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorContentTargetingProtection

    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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains List<string>
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses []string
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses []string
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains []string
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled boolean
    Enables the Content Targeting feature.
    geoProtectionMode string
    Specifies how to handle requests.
    geoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses string[]
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode string
    Specifies how to handle requests.
    ipProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl string
    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.
    overrideIpAddresses string[]
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains string[]
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode string
    Specify the action to take.
    referrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_protection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enable_geo_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_ip_protection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enable_ip_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_referrer_protection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enable_referrer_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enabled bool
    Enables the Content Targeting feature.
    geo_protection_mode str
    Specifies how to handle requests.
    geo_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geo_redirect_url str
    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_mode str
    Specifies how to handle requests.
    ip_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ip_redirect_url str
    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_addresses Sequence[str]
    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_mode str
    Specify the action to take.
    referrer_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrer_redirect_url str
    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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCorsSupport

    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders []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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflight_max_age str
    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.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorCustomBehavior

    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDatastream

    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames List<string>
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames []string
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Integer
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled boolean
    Enables 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.
    logEnabled boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames string[]
    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.
    logStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage number
    Specifies the percentage of log data you want to collect for this property.
    streamType string
    Specify the DataStream type.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collect_midgress_traffic bool
    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_names Sequence[str]
    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_title str
    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.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Number
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcp

    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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.
    namespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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 the IoT 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthHmacTransformation

    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm string
    Specifies the hash algorithm.
    hashConversionKey string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_algorithm str
    Specifies the hash algorithm.
    hash_conversion_key str
    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.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthRegexTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthSubstringTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpAuthVariableExtractor

    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField string
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_auth_processing_variable_id str
    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.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpDefaultAuthzGroups

    GroupNames 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    GroupNames []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpDevRelations

    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDcpRealTimeAuth

    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname boolean
    Extracts a hostname from JWT.
    extractJurisdiction boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDeliveryReceipt

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDenyAccess

    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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDenyDirectFailoverAccess

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicCacheId

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDeviceCharacteristicHeader

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDnsAsyncRefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorDnsPrefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorDowngradeProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDownloadCompleteMarker

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDownloadNotification

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDownstreamCache

    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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 a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.

    GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorDynamicThroughtputOptimizationOverride

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorDynamicWebContent

    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_monitoring bool
    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.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEcmsBulkUpload

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDatabase

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern string
    Specifies the regular expression that matches the database name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEcmsDataset

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEcmsObjectKey

    Locked bool
    Indicates 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeConnect

    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements List<string>
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements []string
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines string
    Specifies the maximum number of lines to include in each log.
    aggregateSize string
    Specifies the log's maximum size.
    aggregateTime string
    Specifies how often logs are generated.
    apiConnector string
    Describes the API connector type.
    apiDataElements string[]
    Specifies the data set to log.
    destinationHostname string
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings boolean
    When enabled, overrides default log settings.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_elements Sequence[str]
    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_settings bool
    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.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenter

    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules List<GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules []GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenterFailoverRule
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description string
    Provides a description for the ELB data center, for your own reference.
    enableFailover boolean
    Allows you to specify failover rules.
    failoverRules GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenterFailoverRule[]
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_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[GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenterFailoverRule]
    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 the edgeLoadBalancingOrigin 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.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<Property Map>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingDataCenterFailoverRule

    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname string
    The hostname of the data center to fail over to.
    modifyRequest boolean
    Allows you to modify the request's hostname or path.
    overrideHostname 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.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeLoadBalancingOrigin

    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description string
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description str
    Provides a description for the ELB origin, for your own reference.
    enable_session_persistence bool
    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 the edgeLoadBalancingDataCenter 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_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.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeOriginAuthorization

    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookie_name 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirector

    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy 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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeRedirectorCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeScape

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeSideIncludes

    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets List<string>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets []string
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection boolean
    Denies attempts to inject ESI code.
    enableViaHttp boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled boolean
    Enables ESI processing.
    i18nCharsets string[]
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_http bool
    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 and ISO-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_ip bool
    Allows edge servers to pass the client IP header to the ESI processor.
    pass_set_cookie 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.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEdgeWorker

    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId string
    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.
    mPulse boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_worker str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edge_worker_id str
    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.
    m_pulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    m_pulse_information str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    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.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEnforceMtlsSettings

    CertificateAuthoritySets List<string>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateAuthoritySets []string
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets string[]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_authority_sets Sequence[str]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enable_auth_set bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enable_deny_request bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enable_ocsp_status bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked bool
    Indicates that your 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.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedAkamaiProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorEnhancedProxyDetection

    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction string
    Specifies how to field the proxy request.
    bestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction string
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy boolean
    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.
    detectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode string
    Specifies how to field the proxy request.
    enabled boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment boolean
    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.
    hostingProvider 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.
    publicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter string
    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_action str
    Specifies how to field the proxy request.
    best_practice_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_anonymous_vpn bool
    This enables detection of requests from anonymous VPNs.
    detect_anonymous_vpn_action str
    Specifies how to field anonymous VPN requests.
    detect_anonymous_vpn_redirecturl str
    This specifies the URL to which to redirect anonymous VPN requests.
    detect_hosting_provider bool
    This detects requests from a hosting provider.
    detect_hosting_provider_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detect_hosting_provider_redirecturl str
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detect_public_proxy bool
    This enables detection of requests from public proxies.
    detect_public_proxy_action str
    Specifies how to field public proxy requests.
    detect_public_proxy_redirecturl str
    This specifies the URL to which to redirect public proxy requests.
    detect_residential_proxy bool
    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_proxy_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detect_residential_proxy_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_smart_dns_proxy bool
    This enables detection of requests from smart DNS proxies.
    detect_smart_dns_proxy_action str
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detect_smart_dns_proxy_redirecturl str
    This specifies the URL to which to redirect DNS proxy requests.
    detect_tor_exit_node bool
    This enables detection of requests from Tor exit nodes.
    detect_tor_exit_node_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detect_tor_exit_node_redirecturl str
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detect_vpn_data_center bool
    This enables detection of requests from VPN data centers.
    detect_vpn_data_center_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detect_vpn_data_center_redirecturl str
    This specifies the URL to which to redirect requests from VPN data centers.
    enable_configuration_mode str
    Specifies how to field the proxy request.
    enabled bool
    Applies GeoGuard proxy detection.
    forward_header_enrichment bool
    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_proxy 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.
    tor_exit_node 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.
    vpn_data_center str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorEpdForwardHeaderEnrichment

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFailAction

    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20231030BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20231030BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20231030BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Integer
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Integer
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Integer
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride boolean
    cexCustomPath boolean
    Specifies a custom path.
    cexHostname string
    Specifies a hostname.
    cexPath string
    Specifies a custom path.
    contentCustomPath boolean
    Specifies a custom redirect path.
    contentHostname string
    Specifies the static hostname for the alternate redirect.
    contentPath string
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath boolean
    Allows you to modify the original requested path.
    dynamicMethod string
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20231030BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath boolean
    Uses the redirectPath to customize a new path.
    redirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType string
    Whether to preserve or customize the hostname.
    redirectMethod number
    Specifies the HTTP response code.
    redirectPath string
    Specifies a new path.
    saasCnameEnabled boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    saasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode number
    Assigns a new HTTP status code to the failure response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_parent_override bool
    cex_custom_path bool
    Specifies a custom path.
    cex_hostname str
    Specifies a hostname.
    cex_path str
    Specifies a custom path.
    content_custom_path bool
    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 GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamic_custom_path bool
    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_hostname GetPropertyRulesBuilderRulesV20231030BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    net_storage_path str
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserve_query_string bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol str
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirect_custom_path bool
    Uses the redirectPath to customize a new path.
    redirect_hostname str
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirect_hostname_type str
    Whether to preserve or customize the hostname.
    redirect_method int
    Specifies the HTTP response code.
    redirect_path str
    Specifies a new path.
    saas_cname_enabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saas_cname_level int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saas_query_string str
    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.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode Property Map
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname Property Map
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Number
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Number
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorFailActionCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorFailActionNetStorageHostname

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20231030BehaviorFailoverBotManagerFeatureCompatibility

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFastInvalidate

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFips

    Enable bool
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    enable Boolean
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketing

    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlus

    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorFirstPartyMarketingPlusCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewrite

    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorForwardRewriteCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorG2oheader

    CustomSignStrings List<string>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    CustomSignStrings []string
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Integer
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customSignStrings string[]
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled boolean
    Enables the g2o verification behavior.
    encodingVersion number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked boolean
    Indicates 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.
    secretKey string
    Specifies the shared secret key.
    signedHeader string
    Specifies the name of the header containing encrypted request data.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_strings Sequence[str]
    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 through 5.
    locked bool
    Indicates 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_sign_string bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorGlobalRequestNumber

    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption string
    Specifies how to report the GRN value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorGraphqlCaching

    Advanced string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors boolean
    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.
    operationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_with_errors bool
    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_body_parameter_name str
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operations_url_query_parameter_name str
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    post_request_processing_error_handling str
    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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorGzipResponse

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorHdDataAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorHealthDetection

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects 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 of retryCount.
    retryCount Integer
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 of retryCount.
    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.
    maximumReconnects Number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount Number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorHsafEipBinding

    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Integer
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Integer
    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.
    templateUuid 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.
    customExtractedSerial boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue number
    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.
    templateUuid 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_serial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hash_max_value int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hash_min_value int
    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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Number
    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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorHttp2

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorHttp3

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorHttpStrictTransportSecurity

    Enable bool
    Applies HSTS to this set of requests.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Integer
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains boolean
    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.
    maxAge 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.
    redirectStatusCode number
    Specifies a response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_domains bool
    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_code int
    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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Number
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorHttpToHttpsUpgrade

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImOverride

    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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters List<string>
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters []string
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.
    excludeAllQueryParameters boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters string[]
    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.
    policyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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_query_parameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excluded_query_parameters Sequence[str]
    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_mvar str
    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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManager

    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    applyBestFileType Boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformed
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String
    applyBestFileType boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformed
    enabled boolean
    imageSet 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.
    policySetType string
    resize boolean
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet string
    apply_best_file_type bool
    cp_code_original GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginal
    cp_code_transformed GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformed
    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_type str
    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
    applyBestFileType Boolean
    cpCodeOriginal Property Map
    cpCodeTransformed Property Map
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String

    GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManager

    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    api_reference_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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_default str
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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_region str
    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_policy_set bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal Property Map
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideo

    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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_default str
    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_region str
    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_policy_set bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal Property Map
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorInclude

    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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorInstant

    CustomLinkRelations List<string>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions List<string>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLinkRelations []string
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions []string
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations string[]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions string[]
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_relations Sequence[str]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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 the tieredDistribution 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_store bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetch_no_store_extensions Sequence[str]
    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.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorInstantConfig

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimization

    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching string
    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.
    maximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid string
    This option is for internal usage only.
    useVersioning boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_object_caching str
    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 or GB. 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 or GB.
    template_uuid str
    This option is for internal usage only.
    use_versioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    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.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorLargeFileOptimizationAdvanced

    Enabled bool
    Enables the file optimization behavior.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Integer
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Integer
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest number
    The number of POC fragments to prefetch during the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or GB suffix.
    prefetch_after_request int
    The number of POC fragments to prefetch after the request.
    prefetch_during_request int
    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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Number
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRate

    BitrateTables List<GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables List<GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BitrateTables []GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateBitrateTable
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables []GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateThresholdTable
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables List<GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables List<GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateBitrateTable[]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid string
    This option is for internal usage only.
    thresholdTables GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateThresholdTable[]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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[GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateBitrateTable]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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[GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateThresholdTable]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    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.
    bitrateTables 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 numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables 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 numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateBitrateTable

    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue double
    The numeric indicator of the download rate.
    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue float64
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Double
    The numeric indicator of the download rate.
    bitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue number
    The numeric indicator of the download rate.
    bitrate_unit str
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrate_value float
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Number
    The numeric indicator of the download rate.

    GetPropertyRulesBuilderRulesV20231030BehaviorLimitBitRateThresholdTable

    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Integer
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue 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, or BYTES of the file size.
    threshold_value int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Number
    The numeric indicator of the minimum file size or elapsed download time.

    GetPropertyRulesBuilderRulesV20231030BehaviorLogCustom

    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_field str
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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_log_field bool
    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.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMPulse

    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    apiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid string
    This option is for internal usage only.
    titleOptional 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}}". See Configuration 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorManifestPersonalization

    Enabled bool
    Enables the Manifest Personalization feature.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges string
    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.
    hlsFilterInBitrates string
    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.
    hlsMode string
    Applies with hlsEnabled on.
    hlsPreferredBitrate string
    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.
    hlsQueryParamEnabled boolean
    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.
    hlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_debug_headers bool
    Includes additional Akamai-Manifest-Personalization and Akamai-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_in_bitrate_ranges str
    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_in_bitrates str
    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_bitrate str
    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_param_enabled bool
    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_param_secret_key str
    Specifies a primary key as a token to accompany the request.
    hls_query_param_transition_key str
    Specifies a transition key as a token to accompany the request.
    hls_show_advanced bool
    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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorManifestRerouting

    Locked bool
    Indicates 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorManualServerPush

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMediaAcceleration

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMediaAccelerationQuicOptout

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMediaClient

    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    beaconId 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.
    templateUuid string
    This option is for internal usage only.
    useHybridHttpUdp boolean
    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_http_udp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.

    GetPropertyRulesBuilderRulesV20231030BehaviorMediaFileRetrievalOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMediaOriginFailover

    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes []string
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes []string
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Integer
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Integer
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Integer
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse boolean
    When enabled, caches the error response.
    cacheWindow string
    This sets error response's TTL.
    clientResponseCode string
    Specifies the response code served to the client.
    detectObjectUnavailable boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost string
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery string
    This sets the recovery option.
    objectUnavailableRedirectMethod number
    Specifies a redirect response code.
    objectUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit string
    Sets how many times to retry.
    originUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost string
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath string
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath boolean
    Modifies the request path.
    originUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery string
    This sets the recovery option.
    originUnavailableRedirectMethod number
    Specifies either a redirect response code.
    originUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit string
    Sets how many times to retry.
    originUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost string
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath boolean
    Modifies the request path.
    originUnresponsiveProtocol string
    Specifies which protocol to use.
    originUnresponsiveRecovery string
    This sets the recovery option.
    originUnresponsiveRedirectMethod number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit string
    Sets how many times to retry.
    otherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response bool
    When enabled, caches the error response.
    cache_window str
    This sets error response's TTL.
    client_response_code str
    Specifies the response code served to the client.
    detect_object_unavailable bool
    Allows you to configure failover settings when the origin has content errors.
    detect_object_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    detect_origin_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    detect_origin_unresponsive_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.
    object_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    object_unavailable_backup_host str
    This specifies the origin hostname.
    object_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    object_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    object_unavailable_change_protocol bool
    Changes the request protocol.
    object_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    object_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    object_unavailable_modified_path str
    This specifies the path to form the new URL.
    object_unavailable_modify_request_path bool
    Enabling this allows you to modify the request path.
    object_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    object_unavailable_recovery str
    This sets the recovery option.
    object_unavailable_redirect_method int
    Specifies a redirect response code.
    object_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when there are content errors.
    object_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unavailable_backup_host str
    This specifies the origin hostname.
    origin_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unavailable_change_protocol bool
    Modifies the request protocol.
    origin_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    origin_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unavailable_modified_path str
    This specifies the path to form the new URL.
    origin_unavailable_modify_request_path bool
    Modifies the request path.
    origin_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    origin_unavailable_recovery str
    This sets the recovery option.
    origin_unavailable_redirect_method int
    Specifies either a redirect response code.
    origin_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when the origin responds with errors.
    origin_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unresponsive_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unresponsive_backup_host str
    This specifies the origin hostname.
    origin_unresponsive_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unresponsive_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unresponsive_change_protocol bool
    This allows you to change the request protocol.
    origin_unresponsive_detection_level str
    Specify the level of response to slow origin connections.
    origin_unresponsive_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unresponsive_modified_path str
    This specifies the path to form the new URL.
    origin_unresponsive_modify_request_path bool
    Modifies the request path.
    origin_unresponsive_protocol str
    Specifies which protocol to use.
    origin_unresponsive_recovery str
    This sets the recovery option.
    origin_unresponsive_redirect_method int
    Specifies the redirect response code.
    origin_unresponsive_retry_limit str
    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.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Number
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Number
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMetadataCaching

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorMobileSdkPerformance

    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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to_origin bool
    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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingRequestHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Supplies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Supplies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorModifyIncomingResponseHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Specifies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingRequestHeader

    Action string
    Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies an HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorModifyOutgoingResponseHeader

    Action string
    Either ADD or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies the new HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies the new HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorModifyViaHeader

    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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption string
    Specify how you want to handle the header.
    renameHeaderTo string
    Specifies a new name to replace the existing Via header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to str
    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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorOrigin

    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities List<GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthority>
    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.
    CustomCertificates List<GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificate>
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues List<string>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20231030BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities List<string>
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities []GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthority
    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.
    CustomCertificates []GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificate
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues []string
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20231030BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities []string
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities List<GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthority>
    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.
    customCertificates List<GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificate>
    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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Integer
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort 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. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20231030BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Integer
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    compress boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthority[]
    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.
    customCertificates GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificate[]
    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.
    customForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues string[]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin string
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20231030BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor string
    Specifies which certificate to trust.
    originId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace string
    Specifies replacement text for what saasRegex matches.
    saasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    saasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities string[]
    templateUuid string
    This option is for internal usage only.
    tls13Support boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting boolean
    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.
    trueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey boolean
    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.
    verificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cache_key_hostname str
    Specifies the hostname to use when forming a cache key.
    compress bool
    Enables gzip compression for non-NetStorage origins.
    custom_certificate_authorities Sequence[GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthority]
    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[GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificate]
    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_host_header str
    This specifies the name of the custom host header the edge server should pass to the origin.
    custom_valid_cn_values Sequence[str]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enable_true_client_ip bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forward_host_header str
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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. See Secure 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.
    max_tls_version str
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    min_tls_version str
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin str
    This specifies the media's origin server.
    net_storage GetPropertyRulesBuilderRulesV20231030BehaviorOriginNetStorage
    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_to_honor str
    Specifies which certificate to trust.
    origin_id str
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id 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.
    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_enabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saas_cname_level int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saas_query_string str
    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_enabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standard_certificate_authorities Sequence[str]
    template_uuid str
    This option is for internal usage only.
    tls13_support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tls_version_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    true_client_ip_client_setting bool
    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_ip_header str
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    use_unique_cache_key bool
    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.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities 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.
    customCertificates 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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort Number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage Property Map
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristics

    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings List<string>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings []string
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Integer
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    accessKeyEncryptedStorage boolean
    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.
    adcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod string
    Specifies the authentication method.
    authenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion string
    awsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings string[]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo string
    Provides a region used by Akamai Direct Connection.
    encodingVersion number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService string
    gcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag boolean
    locked boolean
    Indicates 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.
    originLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag boolean
    roleArn string
    secretKey string
    Specifies the shared secret key.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    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_encrypted_storage bool
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    aws_access_key_id str
    Specifies active access key ID linked to your AWS account.
    aws_access_key_version_guid str
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    aws_ar_region str
    aws_host str
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    aws_region str
    This specifies the AWS region code of the location where your bucket resides.
    aws_secret_access_key str
    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_strings Sequence[str]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    direct_connect_geo str
    Provides a region used by Akamai Direct Connection.
    encoding_version int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    end_point_service str
    gcs_access_key_version_guid str
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcs_hmac_key_access_id str
    Specifies the active access ID linked to your Google account.
    gcs_hmac_key_secret str
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostname_tag bool
    locked bool
    Indicates 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.
    origin_location_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    property_id_tag bool
    role_arn str
    secret_key str
    Specifies the shared secret key.
    template_uuid str
    This option is for internal usage only.
    use_custom_sign_string bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCharacteristicsWsd

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificate

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthority

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthorityIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateAuthoritySubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginCustomCertificateSubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryMethod

    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode string
    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.
    recoveryMethod string
    Specifies the recovery method.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_code str
    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.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginFailureRecoveryPolicy

    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Integer
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Integer
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Integer
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    binaryEquivalentContent boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval number
    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.
    monitorOriginResponsiveness boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    tuningParameters 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_content bool
    Synchronizes content between the primary and backup origins, byte for byte.
    enable_ip_avoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled bool
    Activates and configures a recovery policy.
    ip_avoidance_error_threshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ip_avoidance_retry_interval int
    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_responsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitor_response_codes1s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes2s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes3s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitor_status_codes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes1_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes1_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes1_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes2_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes2_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes2_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes3_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes3_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes3_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_custom_timeout int
    Specify a custom timeout, from 1 to 10 seconds.
    origin_responsiveness_enable_recovery bool
    Enables a recovery action for a specific failure condition.
    origin_responsiveness_enable_retry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    origin_responsiveness_monitoring str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    origin_responsiveness_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_timeout str
    The timeout threshold that triggers a retry or recovery action.
    status_code_monitoring1 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring2 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring3 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.
    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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Number
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginIpAcl

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorOriginNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20231030BehaviorPermissionsPolicy

    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives List<string>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives []string
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives string[]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_list str
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissions_policy_directives Sequence[str]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPersistentClientConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorPersistentConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorPersonallyIdentifiableInformation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPhasedRelease

    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes List<string>
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes []string
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes string[]
    Defines the set of failure codes that initiate the failover response.
    failoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate string
    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.
    populationRefresh boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    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_codes Sequence[str]
    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.
    is_shared_policy 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.
    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.
    population_cookie_type 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 effectively NONE.
    population_duration str
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    population_expiration_date str
    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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPhasedReleaseCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorPreconnect

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Preconnectlists List<string>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Preconnectlists []string
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists string[]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists Sequence[str]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPredictiveContentDelivery

    Enabled bool
    Enables the predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPredictivePrefetching

    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled boolean
    Enables the predictive prefetching 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracy_target str
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled bool
    Enables the predictive prefetching 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.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPrefetch

    Enabled bool
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPrefetchable

    Enabled bool
    Allows matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked bool
    Indicates that your 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorPrefreshCache

    Enabled bool
    Enables the cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval Integer
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    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 cache prefreshing 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.
    prefreshval Number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorQuality

    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Integer
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize string
    contentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType string
    country string
    deliveryFormat string
    deliveryType string
    downloadType string
    endUserLocation 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.
    maximumConcurrentUsers string
    objectSize string
    optimizeFor string
    originSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution string
    refreshRate string
    segmentDuration number
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audience_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalog_size str
    content_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    content_type str
    country str
    delivery_format str
    delivery_type str
    download_type str
    end_user_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.
    maximum_concurrent_users str
    object_size str
    optimize_for str
    origin_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularity_distribution str
    refresh_rate str
    segment_duration int
    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.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Number
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorQuicBeta

    Enabled bool
    Enables QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Integer
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quic_offer_percentage int
    The percentage of responses for which to allow QUIC sessions.
    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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRandomSeek

    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv boolean
    Enables random seek optimization in FLV files.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 boolean
    Enables random seek optimization in MP4 files.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv bool
    Enables random seek optimization in FLV files.
    locked bool
    Indicates 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
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 bool
    Enables random seek optimization in MP4 files.
    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.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRapid

    Enabled bool
    Enables API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorReadTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked bool
    Indicates that your 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.

    GetPropertyRulesBuilderRulesV20231030BehaviorRealTimeReporting

    Advanced bool
    Enables advanced options.
    BeaconSamplingPercentage double
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    BeaconSamplingPercentage float64
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage Double
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage number
    Specifies the percentage for sampling.
    enabled boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beacon_sampling_percentage float
    Specifies the percentage for sampling.
    enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked bool
    Indicates that your 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.
    advanced Boolean
    Enables advanced options.
    beaconSamplingPercentage Number
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRealUserMonitoring

    Enabled bool
    When enabled, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked bool
    Indicates that your 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRedirect

    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Integer
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol string
    Choose the protocol for the redirect URL.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    queryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode number
    Specify the redirect's response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination_hostname str
    Specify how to change the requested hostname, independently from the pathname.
    destination_hostname_other str
    Specifies the full hostname with which to replace the current hostname.
    destination_hostname_sibling str
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destination_hostname_subdomain str
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destination_path str
    Specify how to change the requested pathname, independently from the hostname.
    destination_path_other str
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destination_path_prefix str
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destination_path_suffix str
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destination_path_suffix_status str
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destination_protocol str
    Choose the protocol for the redirect URL.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobile_default_choice str
    Either specify a default response for mobile browsers, or customize your own.
    query_string str
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    response_code int
    Specify the redirect's 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.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Number
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRedirectplus

    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Integer
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled boolean
    Enables the redirect 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.
    responseCode number
    Assigns the status code for the redirect response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination str
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled bool
    Enables the redirect 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.
    response_code int
    Assigns the status code for the redirect 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.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Number
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRefererChecking

    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains List<string>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains []string
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains string[]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled boolean
    Enables the referer-checking 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.
    strict boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_children bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains Sequence[str]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled bool
    Enables the referer-checking 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.
    strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    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.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRemoveQueryParameter

    Locked bool
    Indicates 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 parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Parameters []string
    Specifies parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters List<String>
    Specifies parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters string[]
    Specifies parameters to remove from the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters Sequence[str]
    Specifies parameters to remove from 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.
    locked Boolean
    Indicates 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 parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRemoveVary

    Enabled bool
    When enabled, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked bool
    Indicates that your 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorReport

    Cookies List<string>
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Cookies []string
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies string[]
    This specifies the set of cookies names whose values you want to log.
    customLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage boolean
    Log the Accept-Language header.
    logCookies string
    Specifies the set of cookies to log.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    logEdgeIp boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost boolean
    Log the Host header.
    logReferer boolean
    Log the Referer header.
    logUserAgent boolean
    Log the User-Agent header.
    logXForwardedFor boolean
    Log any X-Forwarded-For request header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies Sequence[str]
    This specifies the set of cookies names whose values you want to log.
    custom_log_field str
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked bool
    Indicates 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_accept_language bool
    Log the Accept-Language header.
    log_cookies str
    Specifies the set of cookies to log.
    log_custom_log_field bool
    Whether to append additional custom data to each log line.
    log_edge_ip bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    log_host bool
    Log the Host header.
    log_referer bool
    Log the Referer header.
    log_user_agent bool
    Log the User-Agent header.
    log_x_forwarded_for bool
    Log any X-Forwarded-For request 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.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRequestClientHints

    AcceptChes List<string>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes List<string>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AcceptChes []string
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes []string
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes string[]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes string[]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accept_ches Sequence[str]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    accept_critical_ches Sequence[str]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your 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.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRequestControl

    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Integer
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Integer
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode number
    Specifies the response status code for the branded deny action.
    branded403Url string
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403_file str
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403_status_code int
    Specifies the response status code for the branded deny action.
    branded403_url str
    Specifies the redirect URL for the branded deny action.
    branded_deny_cache_ttl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enable_branded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled bool
    Enables the Request Control Cloudlet.
    is_shared_policy 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.
    net_storage GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    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.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Number
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage Property Map
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorRequestControlNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20231030BehaviorRequestTypeMarker

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType string
    Specifies the type of request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    request_type str
    Specifies the type of 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizer

    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorResourceOptimizerExtendedCompatibility

    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures boolean
    Enables additional support and error handling.
    enabled boolean
    Enables the Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_all_features bool
    Enables additional support and error handling.
    enabled bool
    Enables the Resource Optimizer 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.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Integer
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode number
    The HTTP status code to replace the existing one.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    status_code int
    The HTTP status code to replace the existing one.
    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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Number
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorResponseCookie

    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled boolean
    Allows you to set a response cookie.
    expirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires string
    Sets various ways to specify when the cookie expires.
    format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid string
    This option is for internal usage only.
    type string
    What type of value to assign.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookie_name str
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    default_domain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    default_path bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain str
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration str
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled bool
    Allows you to set a response cookie.
    expiration_date str
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires str
    Sets various ways to specify when the cookie expires.
    format str
    When the type of cookie is set to UNIQUE, this sets the date format.
    http_only bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path str
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    same_site str
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    template_uuid str
    This option is for internal usage only.
    type str
    What type of value to assign.
    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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.

    GetPropertyRulesBuilderRulesV20231030BehaviorRestrictObjectCaching

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_size str
    Specifies a fixed maximum size of non-HTML content to cache.
    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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorReturnCacheStatus

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    response_header_name str
    Specifies the name of the HTTP header in which to report the cache status 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRewriteUrl

    Behavior string
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString boolean
    When enabled, retains the original path's query parameters.
    locked boolean
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keep_query_string bool
    When enabled, retains the original path's query parameters.
    locked bool
    Indicates 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 str
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    match_multiple bool
    When enabled, replaces all potential matches rather than only the first.
    match_regex str
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    target_path str
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    target_path_prepend str
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    target_regex str
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    target_url str
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorRumCustom

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Integer
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rum_group_name str
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rum_sample_rate int
    Specifies the percentage of web traffic to include in your RUM 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSaasDefinitions

    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    applicationAction string
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie string
    This specifies the name of the cookie that identifies the application.
    applicationQueryString string
    This names the query parameter that identifies the application.
    applicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction string
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie string
    This specifies the name of the cookie that identifies the customer.
    customerQueryString string
    This names the query parameter that identifies the customer.
    customerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid string
    This option is for internal usage only.
    usersAction string
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie string
    This specifies the name of the cookie that identifies the user.
    usersQueryString string
    This names the query parameter that identifies the user.
    usersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    application_action str
    Specifies the request component that identifies a SaaS application.
    application_cname_enabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    application_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    application_cookie str
    This specifies the name of the cookie that identifies the application.
    application_query_string str
    This names the query parameter that identifies the application.
    application_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    application_replace str
    Specifies a string to replace the request's application ID matched by applicationRegex.
    application_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customer_action str
    Specifies the request component that identifies a SaaS customer.
    customer_cname_enabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customer_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    customer_cookie str
    This specifies the name of the cookie that identifies the customer.
    customer_query_string str
    This names the query parameter that identifies the customer.
    customer_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customer_replace str
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customer_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.
    users_action str
    Specifies the request component that identifies a SaaS user.
    users_cname_enabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    users_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    users_cookie str
    This specifies the name of the cookie that identifies the user.
    users_query_string str
    This names the query parameter that identifies the user.
    users_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    users_replace str
    Specifies a string to replace the request's user ID matched by usersRegex.
    users_title 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudClient

    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader string
    Specifies where the Host header is defined.
    originType string
    Specifies where the origin is.
    sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_override_origin_cache_key bool
    When enabled, overrides the forwarding origin's cache key.
    connector_id str
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked bool
    Indicates 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_host_header str
    Specifies where the Host header is defined.
    origin_type str
    Specifies where the origin is.
    sf3c_origin_host str
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3c_origin_host_header str
    This specifies the hostname or IP address of the custom Salesforce host 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.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProvider

    Enabled bool
    Enables Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked bool
    Indicates that your 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSalesForceCommerceCloudProviderHostHeader

    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource string
    Specify where the host header derives 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    host_header_source str
    Specify where the host header derives 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.
    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.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSavePostDcaProcessing

    Enabled bool
    Enables processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    enabled Boolean
    Enables processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorScheduleInvalidation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod string
    Specifies how to invalidate the content.
    repeat boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start string
    The UTC date and time when matching cached content is to expire.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refresh_method str
    Specifies how to invalidate the content.
    repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeat_interval str
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start str
    The UTC date and time when matching cached content is to expire.
    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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorScriptManagement

    Enabled bool
    Enables the Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Integer
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid string
    This option is for internal usage only.
    timestamp number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker str
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    template_uuid str
    This option is for internal usage only.
    timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedContentProtection

    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts List<string>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles List<string>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts []string
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles []string
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Integer
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption boolean
    Whether to enable DASH Media Encryption.
    dataPayload boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled boolean
    Enables the segmented content protection behavior.
    fieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts string[]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles string[]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption boolean
    Enables HLS Segment Encryption.
    ip boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid string
    This option is for internal usage only.
    tokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dash_media_encryption bool
    Whether to enable DASH Media Encryption.
    data_payload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enable_token_in_uri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled bool
    Enables the segmented content protection behavior.
    field_carry_over str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    header_for_salts Sequence[str]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hls_master_manifest_files Sequence[str]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hls_media_encryption bool
    Enables HLS Segment Encryption.
    ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key str
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked bool
    Indicates 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_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revoked_list_id int
    Identifies the TokenAuth tokens to block from accessing your content.
    salt str
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    session_id bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    template_uuid str
    This option is for internal usage only.
    token_auth_hls_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_authentication_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_revocation_enabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    token_revocation_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transition_key str
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    use_advanced bool
    Allows you to specify advanced transitionKey and salt options.
    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.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaOptimization

    Behavior string
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType string
    The type of DVR.
    dvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime string
    This specifies when the live media event ends.
    liveType string
    The type of live 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.
    showAdvanced boolean
    Allows you to configure advanced media options.
    startTime string
    This specifies when the live media event begins.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvr_type str
    The type of DVR.
    dvr_window str
    Set the duration for your media, or 0m if a DVR is not required.
    enable_ull_streaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    end_time str
    This specifies when the live media event ends.
    live_type str
    The type of live 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.
    show_advanced bool
    Allows you to configure advanced media options.
    start_time str
    This specifies when the live media event begins.
    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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSegmentedMediaStreamingPrefetch

    Enabled bool
    Enables media stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked bool
    Indicates that your 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSetVariable

    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Integer
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Integer
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Integer
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Integer
    Specifies a maximum value for the generated integer.
    maxRandomNumber Integer
    Specifies the upper bound of the random number.
    min Integer
    Specifies a minimum value for the generated integer.
    minRandomNumber Integer
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Integer
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Integer
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm string
    Specifies the algorithm to apply.
    caseSensitive boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName string
    Specifies the certificate's content.
    cookieName string
    Specifies the name of the cookie to extract.
    deviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode string
    Specifies the encryption mode.
    endIndex number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation string
    This specifies from where to get the value.
    forceChars string
    Specifies characters to encode, possibly overriding the default set.
    formatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator string
    This specifies the type of value to generate.
    globalSubstitution boolean
    Replaces all matches in the string, not just the first.
    headerName string
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion string
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked boolean
    Indicates 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 number
    Specifies a maximum value for the generated integer.
    maxRandomNumber number
    Specifies the upper bound of the random number.
    min number
    Specifies a minimum value for the generated integer.
    minRandomNumber number
    Specifies the lower bound of the random number.
    nonce string
    Specifies the one-time number used for encryption.
    numberOfBytes number
    Specifies the number of random hex bytes to generate.
    operandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    separator string
    Specifies the character that separates pairs of values within the string.
    setCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    startIndex number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid string
    This option is for internal usage only.
    transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource string
    Determines how you want to set the value.
    variableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm str
    Specifies the algorithm to apply.
    case_sensitive bool
    Enabling this makes all matches case sensitive.
    certificate_field_name str
    Specifies the certificate's content.
    cookie_name str
    Specifies the name of the cookie to extract.
    device_profile str
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryption_key str
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryption_mode str
    Specifies the encryption mode.
    end_index int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    except_chars str
    Specifies characters not to encode, possibly overriding the default set.
    extract_location str
    This specifies from where to get the value.
    force_chars str
    Specifies characters to encode, possibly overriding the default set.
    format_string str
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator str
    This specifies the type of value to generate.
    global_substitution bool
    Replaces all matches in the string, not just the first.
    header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    hmac_algorithm str
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmac_key str
    Specifies the secret to use in generating the base64-encoded digest.
    initialization_vector str
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ip_version str
    Specifies the IP version under which a subnet mask generates.
    ipv4_prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6_prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    location_id str
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    max_random_number int
    Specifies the upper bound of the random number.
    min int
    Specifies a minimum value for the generated integer.
    min_random_number int
    Specifies the lower bound of the random number.
    nonce str
    Specifies the one-time number used for encryption.
    number_of_bytes int
    Specifies the number of random hex bytes to generate.
    operand_one str
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    param_name str
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    path_component_offset str
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prepend_bytes bool
    Specifies a number of random bytes to prepend to the key.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the value.
    regex str
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement str
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    response_header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    separator str
    Specifies the character that separates pairs of values within the string.
    set_cookie_name str
    Specifies the name of the origin's Set-Cookie response header.
    start_index int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    sub_string str
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    template_uuid str
    This option is for internal usage only.
    transform str
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    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_source str
    Determines how you want to set the value.
    variable_name str
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variable_value str
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Number
    Specifies a maximum value for the generated integer.
    maxRandomNumber Number
    Specifies the upper bound of the random number.
    min Number
    Specifies a minimum value for the generated integer.
    minRandomNumber Number
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Number
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.

    GetPropertyRulesBuilderRulesV20231030BehaviorSimulateErrorCode

    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType string
    Specifies the type of 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.
    templateUuid string
    This option is for internal usage only.
    timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    error_type str
    Specifies the type of 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.
    timeout str
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    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.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSiteShield

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20231030BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20231030BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20231030BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20231030BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20231030BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap Property Map
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorSiteShieldSsmap

    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String
    chinaCdnMap string
    hasMixedHosts boolean
    name string
    src string
    srmap string
    value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String

    GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigration

    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Integer
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Integer
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration number
    Specifies the number cache sharing days.
    cacheSharingStartTime string
    Specifies when to start cache sharing.
    enabled boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration number
    Specifies the number of days to migrate the cache.
    migrationFrom string
    What kind of traffic you're migrating from.
    migrationStartTime string
    Specifies when to start migrating the cache.
    tdLocation string
    Specifies the tieredDistribution location.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_https_downgrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allow_https_upgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cache_sharing_duration int
    Specifies the number cache sharing days.
    cache_sharing_start_time str
    Specifies when to start cache sharing.
    enabled bool
    Allows migration to Standard TLS.
    is_certificate_sni_only bool
    Sets whether your new certificate is SNI-only.
    is_tiered_distribution_used bool
    Allows you to align traffic to various tieredDistribution areas.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migration_duration int
    Specifies the number of days to migrate the cache.
    migration_from str
    What kind of traffic you're migrating from.
    migration_start_time str
    Specifies when to start migrating the cache.
    td_location str
    Specifies the tieredDistribution location.
    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.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Number
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Number
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorStandardTlsMigrationOverride

    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorStrictHeaderParsing

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strict_mode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers 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.
    valid_mode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.

    GetPropertyRulesBuilderRulesV20231030BehaviorSubCustomer

    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey boolean
    Allows you to set which query parameters are included in the cache key.
    caching boolean
    Modifies content caching rules.
    contentCompressor boolean
    Allows compression of subcustomer content.
    dynamicWebContent boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery boolean
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery boolean
    Enables delivery of media assets to subcustomers.
    origin boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid string
    This option is for internal usage only.
    tokenAuthorization boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    access_control bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cache_key bool
    Allows you to set which query parameters are included in the cache key.
    caching bool
    Modifies content caching rules.
    content_compressor bool
    Allows compression of subcustomer content.
    dynamic_web_content bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geo_location bool
    Sets subcustomers' location-based whitelists or blacklists.
    ip bool
    Sets subcustomers' IP whitelists or blacklists.
    large_file_delivery bool
    Enables large file delivery for subcustomers.
    live_video_delivery bool
    locked bool
    Indicates 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_path bool
    Modifies a subcustomer's request path.
    on_demand_video_delivery bool
    Enables delivery of media assets to subcustomers.
    origin bool
    Allows you to assign origin hostnames for customers.
    partner_domain_suffix str
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    refresh_content bool
    Allows you to reschedule when content validates for subcustomers.
    site_failover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    template_uuid str
    This option is for internal usage only.
    token_authorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    web_application_firewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.

    GetPropertyRulesBuilderRulesV20231030BehaviorSureRoute

    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride boolean
    customMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    testObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus string
    Specifies which hostname to use.
    type string
    Specifies the set of edge servers used to test routes.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_fcm_parent_override bool
    custom_map str
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    custom_stat_key str
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enable_custom_key bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    force_ssl_forward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    race_stat_ttl str
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    sr_download_link_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.
    test_object_url str
    Specifies the path and filename for your origin's test object to use in races to test routes.
    to_host str
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    to_host_status str
    Specifies which hostname to use.
    type str
    Specifies the set of edge servers used to test routes.
    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.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorTcpOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorTeaLeaf

    Enabled bool
    When enabled, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Integer
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibm_customer_id int
    The integer identifier for the IBM Tealeaf Connector account.
    limit_to_dynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistribution

    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked bool
    Indicates that your 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.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionAdvanced

    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall boolean
    enabled boolean
    When enabled, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method string
    policy string
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall bool
    enabled bool
    When enabled, activates tiered distribution.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method str
    policy str
    template_uuid str
    This option is for internal usage only.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorTieredDistributionCustomization

    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled boolean
    Enables custom maps.
    customMapName string
    Specifies the custom map name.
    hashAlgorithm string
    Specifies the hash algorithm.
    location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate string
    Specifies when the map migration should end.
    migrationStartDate string
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart string
    Specifies a numeric serial start value.
    templateUuid string
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapper_map_migration_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    custom_map_enabled bool
    Enables custom maps.
    custom_map_name str
    Specifies the custom map name.
    hash_algorithm str
    Specifies the hash algorithm.
    location str
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    map_migration_enabled bool
    Enables migration of the custom map to Cloud Wrapper.
    migration_end_date str
    Specifies when the map migration should end.
    migration_start_date str
    Specifies when to start migrating the map.
    migration_within_cw_maps_enabled bool
    Enables migration within Cloud Wrapper maps.
    serial_end str
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serial_start str
    Specifies a numeric serial start value.
    template_uuid str
    This option is for internal usage only.
    tier1_title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked bool
    Indicates that your 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.

    GetPropertyRulesBuilderRulesV20231030BehaviorUidConfiguration

    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled boolean
    Allows you to extract UIDs from client requests.
    extractLocation string
    Where to extract the UID value from.
    headerName string
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled bool
    Allows you to extract UIDs from client requests.
    extract_location str
    Where to extract the UID value from.
    header_name str
    This specifies the name of the HTTP header from which to extract the UID value.
    legal_text 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.
    query_parameter_name str
    This specifies the name of the query parameter from which to extract the UID 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 rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.

    GetPropertyRulesBuilderRulesV20231030BehaviorValidateEntityTag

    Enabled bool
    Enables the ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebToken

    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation string
    Specify from where to extract the JWT value.
    headerName string
    This specifies the name of the header from which to extract the JWT value.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extract_location str
    Specify from where to extract the JWT value.
    header_name str
    This specifies the name of the header from which to extract the JWT value.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates 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_name str
    This specifies the name of the query parameter from which to extract the JWT 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.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorVerifyJsonWebTokenForDcp

    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.
    authorizations string
    This specifies the authorization group name.
    clientId string
    This specifies the claim name.
    customHeader boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation string
    Specifies where to get the JWT value from.
    extractUserName boolean
    Allows you to extract the user name stored in the JWT.
    headerName string
    This specifies the name of the header to extract the JWT value from.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    userName string
    This specifies the user 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.
    authorizations str
    This specifies the authorization group name.
    client_id str
    This specifies the claim name.
    custom_header bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enable_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extract_authorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    extract_client_id bool
    Allows you to extract the client ID claim name stored in JWT.
    extract_location str
    Specifies where to get the JWT value from.
    extract_user_name bool
    Allows you to extract the user name stored in the JWT.
    header_name str
    This specifies the name of the header to extract the JWT value from.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primary_location str
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the JWT value.
    template_uuid str
    This option is for internal usage only.
    user_name str
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorVerifyTokenAuthorization

    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location string
    Specifies where to find the token in the incoming request.
    locationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid string
    This option is for internal usage only.
    transitionKey string
    Specifies a transition key as a hex value.
    useAdvanced boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm str
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escape_hmac_inputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    failure_response bool
    When enabled, sends an HTTP error when an authentication test fails.
    ignore_query_string bool
    Enabling this removes the query string from the URL used to form an encryption key.
    key str
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location str
    Specifies where to find the token in the incoming request.
    location_id str
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt str
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    template_uuid str
    This option is for internal usage only.
    transition_key str
    Specifies a transition key as a hex value.
    use_advanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    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.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoom

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorVirtualWaitingRoomWithEdgeWorkers

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritization

    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders List<string>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams List<string>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders []string
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams []string
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Integer
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Integer
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Integer
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Integer
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Visitor Prioritization 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.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp boolean
    Allows IP addresses to identify users.
    userIdentificationByParams boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders string[]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams string[]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowed_user_cookie_advanced bool
    Sets advanced configuration options for the allowed user's cookie.
    allowed_user_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowed_user_cookie_domain str
    Specifies a domain for an allowed user cookie.
    allowed_user_cookie_domain_type str
    Specify with allowedUserCookieAdvanced enabled.
    allowed_user_cookie_duration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowed_user_cookie_enabled bool
    Sets a cookie for users who have been allowed through to the site.
    allowed_user_cookie_http_only bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowed_user_cookie_label str
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowed_user_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowed_user_cookie_refresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowed_user_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudlet_policy GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Visitor Prioritization 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.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by the values of GET or POST request headers.
    user_identification_by_ip bool
    Allows IP addresses to identify users.
    user_identification_by_params bool
    When enabled, identifies users by the values of GET or POST request parameters.
    user_identification_key_cookie str
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    user_identification_key_headers Sequence[str]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    user_identification_key_params Sequence[str]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    user_identification_title 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.
    waiting_room_cache_ttl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waiting_room_cookie_advanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waiting_room_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waiting_room_cookie_domain str
    Specifies a domain for the waiting room cookie.
    waiting_room_cookie_domain_type str
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waiting_room_cookie_duration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waiting_room_cookie_enabled bool
    Enables a cookie to track a waiting room assignment.
    waiting_room_cookie_http_only bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waiting_room_cookie_label str
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waiting_room_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waiting_room_cookie_share_label bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waiting_room_cp_code GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waiting_room_directory str
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waiting_room_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_net_storage GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waiting_room_status_code int
    Specifies the response code for requests sent to the waiting room.
    waiting_room_use_cp_code bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode Property Map
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage Property Map
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifo

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies how to set the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationFifoStandalone

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030BehaviorVisitorPrioritizationWaitingRoomNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20231030BehaviorWatermarking

    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid string
    This option is for internal usage only.
    tokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 string
    Specifies a unique identifier for the first public key.
    verificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 string
    Specifies the first public key in its entirety.
    verificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    ab_variant_location str
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryption_password1 str
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryption_password2 str
    Provides the secondary password you can use to rotate passwords.
    decryption_password_id1 str
    Specifies a label that corresponds to the primary password.
    decryption_password_id2 str
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable bool
    Enables the watermarking 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.
    miscellaneous_settings_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    pattern_decryption_enable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    pattern_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signature_verification_enable bool
    When enabled, you can verify the signature in your watermarking token.
    template_uuid str
    This option is for internal usage only.
    token_signing_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    use_original_as_a bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    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_key_id1 str
    Specifies a unique identifier for the first public key.
    verification_key_id2 str
    Specifies a unique identifier for the optional second public key.
    verification_public_key1 str
    Specifies the first public key in its entirety.
    verification_public_key2 str
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.

    GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewall

    FirewallConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FirewallConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewall_configuration GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    firewallConfiguration Property Map
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorWebApplicationFirewallFirewallConfiguration

    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Integer
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId number
    fileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    config_id int
    file_name str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Number
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior

    GetPropertyRulesBuilderRulesV20231030BehaviorWebSockets

    Enabled bool
    Enables WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030BehaviorWebdav

    Enabled bool
    Enables the WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030Criterion

    AdvancedImMatch GetPropertyRulesBuilderRulesV20231030CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20231030CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20231030CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20231030CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20231030CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20231030CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20231030CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20231030CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20231030CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20231030CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20231030CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20231030CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20231030CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20231030CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20231030CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20231030CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20231030CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20231030CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20231030CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20231030CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20231030CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20231030CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20231030CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20231030CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20231030CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20231030CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20231030CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20231030CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20231030CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20231030CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20231030CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20231030CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20231030CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20231030CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20231030CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20231030CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20231030CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20231030CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20231030CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20231030CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20231030CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20231030CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    AdvancedImMatch GetPropertyRulesBuilderRulesV20231030CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20231030CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20231030CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20231030CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20231030CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20231030CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20231030CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20231030CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20231030CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20231030CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20231030CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20231030CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20231030CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20231030CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20231030CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20231030CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20231030CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20231030CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20231030CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20231030CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20231030CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20231030CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20231030CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20231030CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20231030CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20231030CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20231030CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20231030CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20231030CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20231030CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20231030CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20231030CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20231030CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20231030CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20231030CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20231030CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20231030CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20231030CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20231030CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20231030CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20231030CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20231030CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20231030CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20231030CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20231030CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20231030CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20231030CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20231030CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20231030CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20231030CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20231030CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20231030CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20231030CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20231030CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20231030CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20231030CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20231030CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20231030CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20231030CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20231030CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20231030CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20231030CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20231030CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20231030CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20231030CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20231030CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20231030CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20231030CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20231030CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20231030CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20231030CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20231030CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20231030CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20231030CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20231030CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20231030CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20231030CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20231030CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20231030CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20231030CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20231030CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20231030CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20231030CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20231030CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20231030CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20231030CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20231030CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20231030CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20231030CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20231030CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20231030CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20231030CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20231030CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20231030CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20231030CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20231030CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20231030CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20231030CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20231030CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20231030CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20231030CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20231030CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20231030CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20231030CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20231030CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20231030CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20231030CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20231030CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20231030CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20231030CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20231030CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20231030CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20231030CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20231030CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20231030CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20231030CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20231030CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20231030CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20231030CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20231030CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20231030CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20231030CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20231030CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20231030CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20231030CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20231030CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advanced_im_match GetPropertyRulesBuilderRulesV20231030CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20231030CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20231030CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    china_cdn_region GetPropertyRulesBuilderRulesV20231030CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    client_certificate GetPropertyRulesBuilderRulesV20231030CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    client_ip GetPropertyRulesBuilderRulesV20231030CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    client_ip_version GetPropertyRulesBuilderRulesV20231030CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudlets_origin GetPropertyRulesBuilderRulesV20231030CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    content_delivery_network GetPropertyRulesBuilderRulesV20231030CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    content_type GetPropertyRulesBuilderRulesV20231030CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    device_characteristic GetPropertyRulesBuilderRulesV20231030CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmd_auth_groups GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmd_auth_scheme GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmd_is_authenticated GetPropertyRulesBuilderRulesV20231030CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmd_username GetPropertyRulesBuilderRulesV20231030CriterionEcmdUsername
    This criterion can be used in includes.
    edge_workers_failure GetPropertyRulesBuilderRulesV20231030CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    file_extension GetPropertyRulesBuilderRulesV20231030CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20231030CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20231030CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    match_advanced GetPropertyRulesBuilderRulesV20231030CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    match_cp_code GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    match_response_code GetPropertyRulesBuilderRulesV20231030CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    match_variable GetPropertyRulesBuilderRulesV20231030CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadata_stage GetPropertyRulesBuilderRulesV20231030CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    origin_timeout GetPropertyRulesBuilderRulesV20231030CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20231030CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    query_string_parameter GetPropertyRulesBuilderRulesV20231030CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20231030CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recovery_config GetPropertyRulesBuilderRulesV20231030CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regular_expression GetPropertyRulesBuilderRulesV20231030CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    request_cookie GetPropertyRulesBuilderRulesV20231030CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    request_header GetPropertyRulesBuilderRulesV20231030CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    request_method GetPropertyRulesBuilderRulesV20231030CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    request_protocol GetPropertyRulesBuilderRulesV20231030CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    request_type GetPropertyRulesBuilderRulesV20231030CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    response_header GetPropertyRulesBuilderRulesV20231030CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    server_location GetPropertyRulesBuilderRulesV20231030CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20231030CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    token_authorization GetPropertyRulesBuilderRulesV20231030CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    user_agent GetPropertyRulesBuilderRulesV20231030CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    user_location GetPropertyRulesBuilderRulesV20231030CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    user_network GetPropertyRulesBuilderRulesV20231030CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variable_error GetPropertyRulesBuilderRulesV20231030CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtual_waiting_room_request GetPropertyRulesBuilderRulesV20231030CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitor_prioritization_request GetPropertyRulesBuilderRulesV20231030CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch Property Map
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket Property Map
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability Property Map
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion Property Map
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate Property Map
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp Property Map
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion Property Map
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin Property Map
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork Property Map
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType Property Map
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic Property Map
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups Property Map
    This criterion can be used in includes.
    ecmdAuthScheme Property Map
    This criterion can be used in includes.
    ecmdIsAuthenticated Property Map
    This criterion can be used in includes.
    ecmdUsername Property Map
    This criterion can be used in includes.
    edgeWorkersFailure Property Map
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension Property Map
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename Property Map
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname Property Map
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced Property Map
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode Property Map
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode Property Map
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable Property Map
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage Property Map
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout Property Map
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path Property Map
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter Property Map
    Matches query string field names or values. This criterion can be used in includes.
    random Property Map
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig Property Map
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression Property Map
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie Property Map
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod Property Map
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol Property Map
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType Property Map
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation Property Map
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time Property Map
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization Property Map
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent Property Map
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation Property Map
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork Property Map
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError Property Map
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest Property Map
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest Property Map
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.

    GetPropertyRulesBuilderRulesV20231030CriterionAdvancedImMatch

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the match's scope.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the match's scope.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionBucket

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage Integer
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage number
    Specifies the percentage of requests to match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage int
    Specifies the percentage of requests to match.
    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.
    percentage Number
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionCacheability

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    match_operator str
    Specifies the match's logic.
    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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_CACHE).

    GetPropertyRulesBuilderRulesV20231030CriterionChinaCdnRegion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionClientCertificate

    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforce_mtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    is_certificate_present bool
    Executes rule behaviors only if a client certificate authenticates requests.
    is_certificate_valid str
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked bool
    Indicates that your 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.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionClientIp

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    IP or CIDR block, for example: 71.92.0.0/14.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    useHeaders boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked bool
    Indicates 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_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    template_uuid str
    This option is for internal usage only.
    use_headers bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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.
    values Sequence[str]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.

    GetPropertyRulesBuilderRulesV20231030CriterionClientIpVersion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    useXForwardedFor boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked bool
    Indicates that your 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_x_forwarded_for bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.

    GetPropertyRulesBuilderRulesV20231030CriterionCloudletsOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The Cloudlets Origins identifier, limited to alphanumeric and underscore 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionContentDeliveryNetwork

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network string
    Match the network.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network str
    Match the network.
    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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionContentType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Content-Type response header value, for example text/html.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for all values.
    matchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Content-Type response header value, for example text/html.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for all values.
    match_operator str
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    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.
    values Sequence[str]
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.

    GetPropertyRulesBuilderRulesV20231030CriterionDeviceCharacteristic

    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues List<string>
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues []string
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Integer
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic string
    Aspect of the device or browser 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.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues string[]
    When the characteristic expects a string, this specifies the set of values.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue string
    When the characteristic expects a version number, this specifies it as a string.
    boolean_value bool
    When the characteristic expects a boolean value, this specifies the value.
    characteristic str
    Aspect of the device or browser 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_case_sensitive bool
    Sets a case-sensitive match for the stringValue field.
    match_wildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numeric_match_operator str
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numeric_value int
    When the characteristic expects a numeric value, this specifies the number.
    string_match_operator str
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    string_values Sequence[str]
    When the characteristic expects a string, this specifies the set of values.
    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.
    version_match_operator str
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    version_value str
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.

    GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthGroups

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked bool
    Indicates 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_operator 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.
    value str
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20231030CriterionEcmdAuthScheme

    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    auth_scheme 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.
    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.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionEcmdIsAuthenticated

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionEcmdUsername

    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    match_operator 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.
    value str
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20231030CriterionEdgeWorkersFailure

    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus string
    Specify execution status.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    exec_status str
    Specify execution status.
    locked bool
    Indicates that your 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.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionFileExtension

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.

    GetPropertyRulesBuilderRulesV20231030CriterionFilename

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the values field.
    matchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the values field.
    match_operator str
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    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.
    values Sequence[str]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.

    GetPropertyRulesBuilderRulesV20231030CriterionHostname

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked bool
    Indicates 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_operator str
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.

    GetPropertyRulesBuilderRulesV20231030CriterionMatchAdvanced

    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml string
    An XML string that closes the relevant block.
    description string
    A 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.
    openXml string
    An XML string that opens the relevant block.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    close_xml str
    An XML string that closes the relevant block.
    description str
    A 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.
    open_xml str
    An XML string that opens the relevant block.
    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.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to match the CP code, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20231030CriterionMatchCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20231030CriterionMatchResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A set of response codes to match, for example ["404","500"].
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator string
    Matches numeric range or a specified set of values.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A set of response codes to match, for example ["404","500"].
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    match_operator str
    Matches numeric range or a specified set of values.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    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.
    values Sequence[str]
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].

    GetPropertyRulesBuilderRulesV20231030CriterionMatchVariable

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues List<string>
    Specifies an array of matching strings.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues []string
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound string
    Specifies the range's numeric minimum value.
    matchCaseSensitive boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound string
    Specifies the range's numeric maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression string
    Specifies a single matching string.
    variableName string
    The name of the variable to match.
    variableValues string[]
    Specifies an array of matching strings.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound str
    Specifies the range's numeric minimum value.
    match_case_sensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    match_operator str
    The type of match, based on which you use different options to specify the match criteria.
    match_wildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound str
    Specifies the range's numeric maximum value.
    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_expression str
    Specifies a single matching string.
    variable_name str
    The name of the variable to match.
    variable_values Sequence[str]
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.

    GetPropertyRulesBuilderRulesV20231030CriterionMetadataStage

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Compares the current rule with the specified metadata stage.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked bool
    Indicates 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_operator str
    Compares the current rule with the specified metadata stage.
    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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.

    GetPropertyRulesBuilderRulesV20231030CriterionOriginTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specifies a single required ORIGIN_TIMED_OUT 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionPath

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of the values array.
    normalize boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of the values array.
    normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    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.
    values Sequence[str]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.

    GetPropertyRulesBuilderRulesV20231030CriterionQueryStringParameter

    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The value of the query field, for example, string in ?q=string.
    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.
    escapeValue boolean
    Matches when the value is URL-escaped.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName string
    The name of the query field, for example, q in ?q=string.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The value of the query field, for example, string in ?q=string.
    escape_value bool
    Matches when the value is URL-escaped.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the parameterName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameter_name str
    The name of the query field, for example, q in ?q=string.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.

    GetPropertyRulesBuilderRulesV20231030CriterionRandom

    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket Integer
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    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.
    bucket Number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionRecoveryConfig

    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    config_name str
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked bool
    Indicates that your 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.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionRegularExpression

    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive boolean
    Sets a case-sensitive regular expression 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.
    matchString string
    The string to match, typically the contents of a dynamic variable.
    regex string
    The regular expression (PCRE) to match against the string.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    case_sensitive bool
    Sets a case-sensitive regular expression 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_string str
    The string to match, typically the contents of a dynamic variable.
    regex str
    The regular expression (PCRE) to match against the string.
    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.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionRequestCookie

    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookie_name str
    The name of the cookie, for example, visitor in visitor:anon.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the cookieName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.

    GetPropertyRulesBuilderRulesV20231030CriterionRequestHeader

    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName string
    The name of the request header, for example Accept-Language.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    header_name str
    The name of the request header, for example Accept-Language.
    locked bool
    Indicates 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_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more 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.
    values Sequence[str]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.

    GetPropertyRulesBuilderRulesV20231030CriterionRequestMethod

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked bool
    Indicates 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_operator str
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.

    GetPropertyRulesBuilderRulesV20231030CriterionRequestProtocol

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked bool
    Indicates that your 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.

    GetPropertyRulesBuilderRulesV20231030CriterionRequestType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked bool
    Indicates 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_operator str
    Specifies whether the request IS or IS_NOT the type of specified 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.
    value str
    Specifies the type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.

    GetPropertyRulesBuilderRulesV20231030CriterionResponseHeader

    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName string
    The name of the response header, for example Content-Type.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator string
    Narrows the match according to various criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    header_name str
    The name of the response header, for example Content-Type.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_value bool
    When enabled, the match is case-sensitive for the value field.
    match_operator str
    Narrows the match according to various criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.

    GetPropertyRulesBuilderRulesV20231030CriterionServerLocation

    Continents List<string>
    Continent codes.
    Countries List<string>
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Continents []string
    Continent codes.
    Countries []string
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents string[]
    Continent codes.
    countries string[]
    ISO 3166-1 country codes, such as US or CN.
    locationType string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents Sequence[str]
    Continent codes.
    countries Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    location_type str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    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.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionTime

    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate string
    Sets the start of a time period.
    endDate string
    Sets the end of a fixed time period.
    lastingDate string
    Sets the start of a fixed time period.
    lastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies how to define the range of time.
    repeatBeginDate string
    Sets the start of the initial time period.
    repeatDuration string
    Sets the duration of each repeating time period.
    repeatInterval string
    Sets the time between each repeating time period's starting points.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    apply_daylight_savings_time bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    begin_date str
    Sets the start of a time period.
    end_date str
    Sets the end of a fixed time period.
    lasting_date str
    Sets the start of a fixed time period.
    lasting_duration str
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked bool
    Indicates 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_operator str
    Specifies how to define the range of time.
    repeat_begin_date str
    Sets the start of the initial time period.
    repeat_duration str
    Sets the duration of each repeating time period.
    repeat_interval str
    Sets the time between each repeating time period's starting points.
    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.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionTokenAuthorization

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Error match scope.
    StatusLists List<string>
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Error match scope.
    StatusLists []string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Error match scope.
    statusLists string[]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Error match scope.
    status_lists Sequence[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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionUserAgent

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    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.
    values Sequence[str]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).

    GetPropertyRulesBuilderRulesV20231030CriterionUserLocation

    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues List<string>
    Continent codes.
    CountryValues List<string>
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues []string
    Continent codes.
    CountryValues []string
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps string
    Specifies which IP addresses determine the user's location.
    continentValues string[]
    Continent codes.
    countryValues string[]
    ISO 3166-1 country codes, such as US or CN.
    field string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    check_ips str
    Specifies which IP addresses determine the user's location.
    continent_values Sequence[str]
    Continent codes.
    country_values Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    field str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    region_values Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionUserNetwork

    BandwidthValues List<string>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues List<string>
    NetworkValues List<string>
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BandwidthValues []string
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues []string
    NetworkValues []string
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues string[]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps string
    Specifies which IP addresses determine the user's network.
    field string
    The type of information 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.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues string[]
    networkValues string[]
    Any set of specific networks.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidth_values Sequence[str]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    check_ips str
    Specifies which IP addresses determine the user's network.
    field str
    The type of information 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    network_type_values Sequence[str]
    network_values Sequence[str]
    Any set of specific networks.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionVariableError

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames List<string>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames []string
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames string[]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    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_names Sequence[str]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.

    GetPropertyRulesBuilderRulesV20231030CriterionVirtualWaitingRoomRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CriterionVisitorPrioritizationRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20231030CustomOverride

    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override
    name string
    The name of a custom override
    overrideId string
    The ID of a custom override
    name str
    The name of a custom override
    override_id str
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override

    GetPropertyRulesBuilderRulesV20231030Variable

    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable
    description string
    The description for a variable
    hidden boolean
    Whether a variable should be hidden
    name string
    The name of a variable
    sensitive boolean
    States whether a variable contains sensitive information
    value string
    The value for a variable
    description str
    The description for a variable
    hidden bool
    Whether a variable should be hidden
    name str
    The name of a variable
    sensitive bool
    States whether a variable contains sensitive information
    value str
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable

    GetPropertyRulesBuilderRulesV20240109

    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors List<GetPropertyRulesBuilderRulesV20240109Behavior>
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions List<GetPropertyRulesBuilderRulesV20240109Criterion>
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20240109CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables List<GetPropertyRulesBuilderRulesV20240109Variable>
    A list of variables for a rule
    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors []GetPropertyRulesBuilderRulesV20240109Behavior
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions []GetPropertyRulesBuilderRulesV20240109Criterion
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20240109CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables []GetPropertyRulesBuilderRulesV20240109Variable
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride String
    XML metadata of the rule
    behaviors List<GetPropertyRulesBuilderRulesV20240109Behavior>
    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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<GetPropertyRulesBuilderRulesV20240109Criterion>
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20240109CustomOverride
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid String
    The UUID of a rule template
    uuid String
    The UUID of the rule
    variables List<GetPropertyRulesBuilderRulesV20240109Variable>
    A list of variables for a rule
    name string
    The name of a rule
    advancedOverride string
    XML metadata of the rule
    behaviors GetPropertyRulesBuilderRulesV20240109Behavior[]
    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
    criteriaLocked boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    criterions GetPropertyRulesBuilderRulesV20240109Criterion[]
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20240109CustomOverride
    XML metadata of the rule
    isSecure boolean
    States whether a rule is secure
    templateLink string
    The template link for the rule
    templateUuid string
    The UUID of a rule template
    uuid string
    The UUID of the rule
    variables GetPropertyRulesBuilderRulesV20240109Variable[]
    A list of variables for a rule
    name str
    The name of a rule
    advanced_override str
    XML metadata of the rule
    behaviors Sequence[GetPropertyRulesBuilderRulesV20240109Behavior]
    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_satisfy str
    States whether 'all' criteria need to match or 'any'
    criterions Sequence[GetPropertyRulesBuilderRulesV20240109Criterion]
    The list of criteria for a rule
    custom_override GetPropertyRulesBuilderRulesV20240109CustomOverride
    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[GetPropertyRulesBuilderRulesV20240109Variable]
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride 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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<Property Map>
    The list of criteria for a rule
    customOverride Property Map
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid 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

    GetPropertyRulesBuilderRulesV20240109Behavior

    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240109BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20240109BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20240109BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240109BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20240109BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20240109BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20240109BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20240109BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20240109BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20240109BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20240109BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20240109BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20240109BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20240109BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20240109BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20240109BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20240109BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20240109BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20240109BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20240109BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20240109BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20240109BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20240109BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20240109BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240109BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20240109BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20240109BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20240109BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20240109BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20240109BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20240109BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20240109BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20240109BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20240109BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20240109BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20240109BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20240109BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20240109BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240109BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20240109BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20240109BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20240109BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20240109BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20240109BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20240109BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20240109BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20240109BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20240109BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20240109BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20240109BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20240109BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20240109BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20240109BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20240109BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240109BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20240109BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20240109BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20240109BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20240109BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20240109BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20240109BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20240109BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20240109BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20240109BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240109BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240109BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20240109BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20240109BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20240109BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20240109BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20240109BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20240109BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20240109BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20240109BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20240109BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20240109BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240109BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20240109BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240109BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20240109BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20240109BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20240109BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240109BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20240109BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240109BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20240109BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20240109BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20240109BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20240109BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20240109BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240109BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20240109BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20240109BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20240109BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20240109BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20240109BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20240109BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20240109BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20240109BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20240109BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20240109BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20240109BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20240109BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20240109BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20240109BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20240109BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20240109BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20240109BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20240109BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20240109BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20240109BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20240109BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20240109BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20240109BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20240109BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20240109BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20240109BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20240109BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20240109BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20240109BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20240109BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20240109BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20240109BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20240109BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20240109BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20240109BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20240109BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20240109BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20240109BehaviorWebdav
    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.
    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240109BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20240109BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20240109BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240109BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20240109BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20240109BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20240109BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20240109BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20240109BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20240109BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20240109BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20240109BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20240109BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20240109BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20240109BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20240109BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20240109BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20240109BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20240109BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20240109BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20240109BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20240109BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20240109BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20240109BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240109BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20240109BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20240109BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20240109BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20240109BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20240109BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20240109BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20240109BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20240109BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20240109BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20240109BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20240109BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20240109BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20240109BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240109BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20240109BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20240109BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20240109BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20240109BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20240109BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20240109BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20240109BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20240109BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20240109BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20240109BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20240109BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20240109BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20240109BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20240109BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20240109BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240109BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20240109BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20240109BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20240109BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20240109BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20240109BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20240109BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20240109BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20240109BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20240109BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240109BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240109BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20240109BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20240109BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20240109BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20240109BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20240109BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20240109BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20240109BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20240109BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20240109BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20240109BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240109BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20240109BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240109BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20240109BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20240109BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20240109BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240109BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20240109BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240109BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20240109BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20240109BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20240109BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20240109BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20240109BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240109BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20240109BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20240109BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20240109BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20240109BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20240109BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20240109BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20240109BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20240109BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20240109BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20240109BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20240109BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20240109BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20240109BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20240109BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20240109BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20240109BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20240109BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20240109BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20240109BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20240109BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20240109BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20240109BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20240109BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20240109BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20240109BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20240109BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20240109BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20240109BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20240109BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20240109BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20240109BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20240109BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20240109BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20240109BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20240109BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20240109BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20240109BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20240109BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240109BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20240109BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20240109BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240109BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20240109BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20240109BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20240109BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20240109BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20240109BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20240109BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20240109BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20240109BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20240109BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20240109BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20240109BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20240109BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20240109BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20240109BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20240109BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20240109BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20240109BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20240109BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20240109BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20240109BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240109BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20240109BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20240109BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20240109BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20240109BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20240109BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20240109BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20240109BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20240109BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20240109BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20240109BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20240109BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20240109BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20240109BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240109BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20240109BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20240109BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20240109BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20240109BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20240109BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20240109BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20240109BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20240109BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20240109BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20240109BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20240109BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20240109BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20240109BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20240109BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20240109BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240109BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20240109BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20240109BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20240109BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20240109BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20240109BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20240109BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20240109BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20240109BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20240109BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240109BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240109BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20240109BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20240109BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20240109BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20240109BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20240109BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20240109BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20240109BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20240109BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20240109BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20240109BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240109BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20240109BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240109BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20240109BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20240109BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20240109BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240109BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20240109BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240109BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20240109BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20240109BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20240109BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20240109BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20240109BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240109BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20240109BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20240109BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20240109BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20240109BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20240109BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20240109BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20240109BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20240109BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20240109BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20240109BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20240109BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20240109BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20240109BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20240109BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20240109BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20240109BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20240109BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20240109BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20240109BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20240109BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20240109BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20240109BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20240109BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20240109BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20240109BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20240109BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20240109BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20240109BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20240109BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20240109BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20240109BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20240109BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20240109BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20240109BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20240109BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20240109BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20240109BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20240109BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240109BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20240109BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20240109BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240109BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20240109BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20240109BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20240109BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20240109BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20240109BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20240109BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20240109BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20240109BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20240109BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20240109BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20240109BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20240109BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20240109BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20240109BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20240109BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20240109BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20240109BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20240109BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20240109BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20240109BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240109BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20240109BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20240109BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20240109BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20240109BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20240109BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20240109BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20240109BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20240109BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20240109BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20240109BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20240109BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20240109BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20240109BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240109BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20240109BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20240109BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20240109BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240109BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20240109BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20240109BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20240109BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20240109BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20240109BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20240109BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20240109BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20240109BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20240109BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20240109BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20240109BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20240109BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240109BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20240109BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20240109BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20240109BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20240109BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20240109BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20240109BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20240109BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20240109BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20240109BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240109BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240109BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20240109BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20240109BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20240109BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20240109BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20240109BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20240109BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20240109BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20240109BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20240109BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20240109BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20240109BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240109BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20240109BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240109BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20240109BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20240109BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20240109BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20240109BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240109BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20240109BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240109BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20240109BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20240109BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20240109BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20240109BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20240109BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240109BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20240109BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20240109BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20240109BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20240109BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20240109BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20240109BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20240109BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20240109BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20240109BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20240109BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20240109BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20240109BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20240109BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20240109BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20240109BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20240109BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20240109BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20240109BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20240109BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20240109BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20240109BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20240109BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20240109BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20240109BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20240109BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20240109BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20240109BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20240109BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20240109BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20240109BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20240109BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20240109BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20240109BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20240109BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20240109BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20240109BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20240109BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20240109BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20240109BehaviorWebdav
    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_circuit_breaker GetPropertyRulesBuilderRulesV20240109BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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 GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptive_image_compression GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20240109BehaviorAdvanced
    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 GetPropertyRulesBuilderRulesV20240109BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizer_tag GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizerTag
    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_in_cache_hierarchy GetPropertyRulesBuilderRulesV20240109BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allow_cloudlets_origins GetPropertyRulesBuilderRulesV20240109BehaviorAllowCloudletsOrigins
    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 GetPropertyRulesBuilderRulesV20240109BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_https_cache_key_sharing GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allow_https_downgrade GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsDowngrade
    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 GetPropertyRulesBuilderRulesV20240109BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allow_patch GetPropertyRulesBuilderRulesV20240109BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_post GetPropertyRulesBuilderRulesV20240109BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_put GetPropertyRulesBuilderRulesV20240109BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allow_transfer_encoding GetPropertyRulesBuilderRulesV20240109BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    alt_svc_header GetPropertyRulesBuilderRulesV20240109BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    api_prioritization GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    application_load_balancer GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancer
    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 GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentation
    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_validation GetPropertyRulesBuilderRulesV20240109BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    base_directory GetPropertyRulesBuilderRulesV20240109BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    boss_beaconing GetPropertyRulesBuilderRulesV20240109BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20240109BehaviorBreadcrumbs
    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 GetPropertyRulesBuilderRulesV20240109BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20240109BehaviorBrotli
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cache_id GetPropertyRulesBuilderRulesV20240109BehaviorCacheId
    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_ignore_case GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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_query_params GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyQueryParams
    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_rewrite GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyRewrite
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCachePost
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCacheRedirect
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCacheTag
    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. The cacheTag 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_visible GetPropertyRulesBuilderRulesV20240109BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240109BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    central_authorization GetPropertyRulesBuilderRulesV20240109BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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 GetPropertyRulesBuilderRulesV20240109BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    client_certificate_auth GetPropertyRulesBuilderRulesV20240109BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    client_characteristics GetPropertyRulesBuilderRulesV20240109BehaviorClientCharacteristics
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCloudInterconnects
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloud_wrapper_advanced GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapperAdvanced
    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.
    common_media_client_data GetPropertyRulesBuilderRulesV20240109BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditional_origin GetPropertyRulesBuilderRulesV20240109BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    construct_response GetPropertyRulesBuilderRulesV20240109BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    content_characteristics GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristics
    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_amd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsAmd
    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_dd GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsDd
    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_wsd_large_file GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLargeFile
    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_wsd_live GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLive
    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_wsd_vod GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdVod
    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_position GetPropertyRulesBuilderRulesV20240109BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    content_targeting_protection GetPropertyRulesBuilderRulesV20240109BehaviorContentTargetingProtection
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCorsSupport
    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 GetPropertyRulesBuilderRulesV20240109BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    custom_behavior GetPropertyRulesBuilderRulesV20240109BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20240109BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20240109BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcp_auth_hmac_transformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_regex_transformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_substring_transformation GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_variable_extractor GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthVariableExtractor
    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_authz_groups GetPropertyRulesBuilderRulesV20240109BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcp_dev_relations GetPropertyRulesBuilderRulesV20240109BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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_time_auth GetPropertyRulesBuilderRulesV20240109BehaviorDcpRealTimeAuth
    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 GetPropertyRulesBuilderRulesV20240109BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    deny_access GetPropertyRulesBuilderRulesV20240109BehaviorDenyAccess
    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_failover_access GetPropertyRulesBuilderRulesV20240109BehaviorDenyDirectFailoverAccess
    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_cache_id GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicCacheId
    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_header GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dns_async_refresh GetPropertyRulesBuilderRulesV20240109BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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 GetPropertyRulesBuilderRulesV20240109BehaviorDnsPrefresh
    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 GetPropertyRulesBuilderRulesV20240109BehaviorDowngradeProtocol
    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_marker GetPropertyRulesBuilderRulesV20240109BehaviorDownloadCompleteMarker
    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 GetPropertyRulesBuilderRulesV20240109BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstream_cache GetPropertyRulesBuilderRulesV20240109BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamic_throughtput_optimization GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimization
    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_optimization_override GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimizationOverride
    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_content GetPropertyRulesBuilderRulesV20240109BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecms_bulk_upload GetPropertyRulesBuilderRulesV20240109BehaviorEcmsBulkUpload
    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 GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecms_dataset GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDataset
    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_key GetPropertyRulesBuilderRulesV20240109BehaviorEcmsObjectKey
    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 GetPropertyRulesBuilderRulesV20240109BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edge_load_balancing_advanced GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingAdvanced
    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_balancing_data_center GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenter
    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_balancing_origin GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingOrigin
    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.
    edge_origin_authorization GetPropertyRulesBuilderRulesV20240109BehaviorEdgeOriginAuthorization
    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 GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edge_scape GetPropertyRulesBuilderRulesV20240109BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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_includes GetPropertyRulesBuilderRulesV20240109BehaviorEdgeSideIncludes
    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, or filename. 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 GetPropertyRulesBuilderRulesV20240109BehaviorEdgeWorker
    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.
    enforce_mtls_settings GetPropertyRulesBuilderRulesV20240109BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhanced_akamai_protocol GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedAkamaiProtocol
    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_detection GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedProxyDetection
    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_header_enrichment GetPropertyRulesBuilderRulesV20240109BehaviorEpdForwardHeaderEnrichment
    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 GetPropertyRulesBuilderRulesV20240109BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failover_bot_manager_feature_compatibility GetPropertyRulesBuilderRulesV20240109BehaviorFailoverBotManagerFeatureCompatibility
    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 GetPropertyRulesBuilderRulesV20240109BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20240109BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    first_party_marketing GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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_marketing_plus GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing 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 GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20240109BehaviorG2oheader
    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_number GetPropertyRulesBuilderRulesV20240109BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphql_caching GetPropertyRulesBuilderRulesV20240109BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzip_response GetPropertyRulesBuilderRulesV20240109BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hd_data_advanced GetPropertyRulesBuilderRulesV20240109BehaviorHdDataAdvanced
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHealthDetection
    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_binding GetPropertyRulesBuilderRulesV20240109BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240109BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    http_strict_transport_security GetPropertyRulesBuilderRulesV20240109BehaviorHttpStrictTransportSecurity
    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_https_upgrade GetPropertyRulesBuilderRulesV20240109BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    im_override GetPropertyRulesBuilderRulesV20240109BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    image_and_video_manager GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManager
    This behavior can be used in includes.
    image_manager GetPropertyRulesBuilderRulesV20240109BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    image_manager_video GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20240109BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20240109BehaviorInstant
    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 GetPropertyRulesBuilderRulesV20240109BehaviorInstantConfig
    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_optimization GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    large_file_optimization_advanced GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limit_bit_rate GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    log_custom GetPropertyRulesBuilderRulesV20240109BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    m_pulse GetPropertyRulesBuilderRulesV20240109BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifest_personalization GetPropertyRulesBuilderRulesV20240109BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifest_rerouting GetPropertyRulesBuilderRulesV20240109BehaviorManifestRerouting
    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_push GetPropertyRulesBuilderRulesV20240109BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    media_acceleration GetPropertyRulesBuilderRulesV20240109BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    media_acceleration_quic_optout GetPropertyRulesBuilderRulesV20240109BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    media_client GetPropertyRulesBuilderRulesV20240109BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    media_file_retrieval_optimization GetPropertyRulesBuilderRulesV20240109BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    media_origin_failover GetPropertyRulesBuilderRulesV20240109BehaviorMediaOriginFailover
    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 GetPropertyRulesBuilderRulesV20240109BehaviorMetadataCaching
    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_performance GetPropertyRulesBuilderRulesV20240109BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modify_incoming_request_header GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modify_incoming_response_header GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modify_outgoing_request_header GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modify_outgoing_response_header GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modify_via_header GetPropertyRulesBuilderRulesV20240109BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240109BehaviorOrigin
    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 GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristics
    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_wsd GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    origin_failure_recovery_method GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    origin_failure_recovery_policy GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    origin_ip_acl GetPropertyRulesBuilderRulesV20240109BehaviorOriginIpAcl
    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.
    permissions_policy GetPropertyRulesBuilderRulesV20240109BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistent_client_connection GetPropertyRulesBuilderRulesV20240109BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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 GetPropertyRulesBuilderRulesV20240109BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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_information GetPropertyRulesBuilderRulesV20240109BehaviorPersonallyIdentifiableInformation
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20240109BehaviorPreconnect
    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_delivery GetPropertyRulesBuilderRulesV20240109BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictive_prefetching GetPropertyRulesBuilderRulesV20240109BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240109BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefresh_cache GetPropertyRulesBuilderRulesV20240109BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240109BehaviorQuality
    This behavior can be used in includes.
    quic_beta GetPropertyRulesBuilderRulesV20240109BehaviorQuicBeta
    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 GetPropertyRulesBuilderRulesV20240109BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20240109BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    read_timeout GetPropertyRulesBuilderRulesV20240109BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    real_time_reporting GetPropertyRulesBuilderRulesV20240109BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    real_user_monitoring GetPropertyRulesBuilderRulesV20240109BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20240109BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20240109BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    referer_checking GetPropertyRulesBuilderRulesV20240109BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    remove_query_parameter GetPropertyRulesBuilderRulesV20240109BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    remove_vary GetPropertyRulesBuilderRulesV20240109BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20240109BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    request_client_hints GetPropertyRulesBuilderRulesV20240109BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    request_control GetPropertyRulesBuilderRulesV20240109BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    request_type_marker GetPropertyRulesBuilderRulesV20240109BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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 GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resource_optimizer_extended_compatibility GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizerExtendedCompatibility
    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 GetPropertyRulesBuilderRulesV20240109BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    response_cookie GetPropertyRulesBuilderRulesV20240109BehaviorResponseCookie
    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_caching GetPropertyRulesBuilderRulesV20240109BehaviorRestrictObjectCaching
    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_status GetPropertyRulesBuilderRulesV20240109BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewrite_url GetPropertyRulesBuilderRulesV20240109BehaviorRewriteUrl
    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 GetPropertyRulesBuilderRulesV20240109BehaviorRumCustom
    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 GetPropertyRulesBuilderRulesV20240109BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    sales_force_commerce_cloud_client GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudClient
    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_commerce_cloud_provider GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    sales_force_commerce_cloud_provider_host_header GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    save_post_dca_processing GetPropertyRulesBuilderRulesV20240109BehaviorSavePostDcaProcessing
    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 GetPropertyRulesBuilderRulesV20240109BehaviorScheduleInvalidation
    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 GetPropertyRulesBuilderRulesV20240109BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmented_content_protection GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmented_media_optimization GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmented_media_streaming_prefetch GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaStreamingPrefetch
    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 GetPropertyRulesBuilderRulesV20240109BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulate_error_code GetPropertyRulesBuilderRulesV20240109BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    site_shield GetPropertyRulesBuilderRulesV20240109BehaviorSiteShield
    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_migration GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standard_tls_migration_override GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigrationOverride
    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_parsing GetPropertyRulesBuilderRulesV20240109BehaviorStrictHeaderParsing
    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 GetPropertyRulesBuilderRulesV20240109BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sure_route GetPropertyRulesBuilderRulesV20240109BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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 GetPropertyRulesBuilderRulesV20240109BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    tea_leaf GetPropertyRulesBuilderRulesV20240109BehaviorTeaLeaf
    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 GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistribution
    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 the cache 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_advanced GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tiered_distribution_customization GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20240109BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uid_configuration GetPropertyRulesBuilderRulesV20240109BehaviorUidConfiguration
    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_tag GetPropertyRulesBuilderRulesV20240109BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verify_json_web_token GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verify_json_web_token_for_dcp GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verify_token_authorization GetPropertyRulesBuilderRulesV20240109BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtual_waiting_room GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtual_waiting_room_with_edge_workers GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoomWithEdgeWorkers
    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 GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo_standalone GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20240109BehaviorWatermarking
    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_firewall GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewall
    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 GetPropertyRulesBuilderRulesV20240109BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20240109BehaviorWebdav
    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.
    adScalerCircuitBreaker Property Map
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration 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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression Property Map
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. 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.
    aggregatedReporting Property Map
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. 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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag 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.
    allHttpInCacheHierarchy Property Map
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins Property Map
    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.
    allowDelete 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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing Property Map
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade Property Map
    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.
    allowOptions 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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch 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, and allowPut behaviors. This behavior can be used in includes.
    allowPost 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, and allowPut behaviors. This behavior can be used in includes.
    allowPut 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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding Property Map
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader Property Map
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization 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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer Property Map
    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.
    audienceSegmentation 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.
    autoDomainValidation Property Map
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory Property Map
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing 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.
    breadcrumbs 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.
    breakConnection 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.
    cacheError 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, and 505. This behavior can be used in includes.
    cacheId 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.
    cacheKeyIgnoreCase Property Map
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams Property Map
    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.
    cacheKeyRewrite Property Map
    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.
    cachePost 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.
    cacheRedirect 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.
    cacheTag 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. The cacheTag 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.
    cacheTagVisible Property Map
    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 the modifyOutgoingResponseHeader 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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization 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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects Property Map
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth Property Map
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics 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.
    cloudInterconnects 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.
    cloudWrapper 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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced Property Map
    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.
    commonMediaClientData Property Map
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin Property Map
    This behavior cannot be used in includes.
    constructResponse 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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics 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.
    contentCharacteristicsAmd 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.
    contentCharacteristicsDd 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.
    contentCharacteristicsWsdLargeFile Property Map
    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.
    contentCharacteristicsWsdLive Property Map
    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.
    contentCharacteristicsWsdVod Property Map
    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.
    contentPrePosition Property Map
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection Property Map
    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.
    corsSupport 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.
    cpCode 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 the List CP codes operation. This behavior can be used in includes.
    customBehavior 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 relevant behaviorId value from the response within the current customBehavior. See Custom 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 the DataStream 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. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor Property Map
    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.
    dcpDefaultAuthzGroups Property Map
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations Property Map
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth Property Map
    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.
    deliveryReceipt 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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess 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.
    denyDirectFailoverAccess Property Map
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId Property Map
    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.
    deviceCharacteristicHeader Property Map
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh Property Map
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh 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.
    downgradeProtocol 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.
    downloadCompleteMarker 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 logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes.
    downloadNotification 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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache 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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization Property Map
    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.
    dynamicThroughtputOptimizationOverride Property Map
    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.
    dynamicWebContent Property Map
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload Property Map
    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.
    ecmsDatabase 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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset 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.
    ecmsObjectKey Property Map
    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.
    edgeConnect Property Map
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced Property Map
    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.
    edgeLoadBalancingDataCenter Property Map
    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.
    edgeLoadBalancingOrigin Property Map
    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.
    edgeOriginAuthorization 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.
    edgeRedirector Property Map
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape 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 special X-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.
    edgeSideIncludes Property Map
    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, or filename. 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.
    edgeWorker 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.
    enforceMtlsSettings Property Map
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol Property Map
    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.
    enhancedProxyDetection Property Map
    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.
    epdForwardHeaderEnrichment Property Map
    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.
    failAction 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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility Property Map
    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.
    fastInvalidate Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips Property Map
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing Property Map
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus Property Map
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite 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 within Control Center, or use the Cloudlets API to configure it programmatically. 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.
    globalRequestNumber Property Map
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching Property Map
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse 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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced Property Map
    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.
    healthDetection 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.
    hsafEipBinding Property Map
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity Property Map
    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.
    httpToHttpsUpgrade Property Map
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride 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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager Property Map
    This behavior can be used in includes.
    imageManager 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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo Property Map
    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 a fileExtension. 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.
    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.
    instantConfig 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.
    largeFileOptimization Property Map
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced Property Map
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate Property Map
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom Property Map
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse Property Map
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization 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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting 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.
    manualServerPush Property Map
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration Property Map
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout Property Map
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization Property Map
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover Property Map
    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.
    metadataCaching 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.
    mobileSdkPerformance Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader Property Map
    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.
    originCharacteristics 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.
    originCharacteristicsWsd Property Map
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod Property Map
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy Property Map
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl Property Map
    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.
    permissionsPolicy Property Map
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection Property Map
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection Property Map
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation Property Map
    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.
    phasedRelease 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 within Control 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.
    predictiveContentDelivery Property Map
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching 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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache 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.
    quicBeta 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.
    randomSeek 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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout 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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting Property Map
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring Property Map
    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 on destinationHostname and destinationPath 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 use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking Property Map
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter Property Map
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary Property Map
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary 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.
    requestClientHints Property Map
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker Property Map
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility Property Map
    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.
    responseCode 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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie 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.
    restrictObjectCaching Property Map
    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.
    returnCacheStatus Property Map
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl 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.
    rumCustom 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.
    saasDefinitions Property Map
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient Property Map
    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.
    salesForceCommerceCloudProvider Property Map
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader Property Map
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing Property Map
    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.
    scheduleInvalidation 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.
    scriptManagement Property Map
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection Property Map
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization Property Map
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch Property Map
    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.
    setVariable 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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode Property Map
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield 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.
    standardTlsMigration Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride 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.
    strictHeaderParsing Property Map
    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.
    subCustomer 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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute Property Map
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf 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.
    tieredDistribution 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 the cache 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.
    tieredDistributionAdvanced 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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization Property Map
    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 enable cloudWrapper 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.
    uidConfiguration 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.
    validateEntityTag Property Map
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken Property Map
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp Property Map
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization Property Map
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom Property Map
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers Property Map
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization Property Map
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo Property Map
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone Property Map
    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.
    webApplicationFirewall Property Map
    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.
    webSockets 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorAdScalerCircuitBreaker

    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased string
    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.
    responseCodeBased boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased string
    Defines a custom error response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response_code_based str
    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_based bool
    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, or SPECIFY_YOUR_OWN for a custom code.
    response_delay_based bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    response_delay_threshold str
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    return_error_response_code_based str
    Specifies the error to include in the response to the client.
    specify_your_own_response_code_based str
    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.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveAcceleration

    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid string
    This option is for internal usage only.
    titleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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. See Add 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.
    cookie_name str
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enable_brotli_compression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enable_for_noncacheable bool
    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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring 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_server_push str
    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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorAdaptiveImageCompression

    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Integer
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Integer
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Integer
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Integer
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Integer
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Integer
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    compressMobile boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid string
    This option is for internal usage only.
    tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    tier1MobileCompressionValue number
    Specifies the compression percentage.
    tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue number
    Specifies the compression percentage.
    tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue number
    Specifies the compression percentage.
    tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue number
    Specifies the compression percentage.
    tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue number
    Specifies the compression percentage.
    tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue number
    Specifies the compression percentage.
    titleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    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_compression_method str
    Specifies tier-1 behavior.
    tier1_mobile_compression_value int
    Specifies the compression percentage.
    tier1_standard_compression_method str
    Specifies tier-1 non-cellular network behavior.
    tier1_standard_compression_value int
    Specifies the compression percentage.
    tier2_mobile_compression_method str
    Specifies tier-2 cellular-network behavior.
    tier2_mobile_compression_value int
    Specifies the compression percentage.
    tier2_standard_compression_method str
    Specifies tier-2 non-cellular network behavior.
    tier2_standard_compression_value int
    Specifies the compression percentage.
    tier3_mobile_compression_method str
    Specifies tier-3 cellular-network behavior.
    tier3_mobile_compression_value int
    Specifies the compression percentage.
    tier3_standard_compression_method str
    Specifies tier-3 non-cellular network behavior.
    tier3_standard_compression_value int
    Specifies the compression percentage.
    title_aic_mobile str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    title_aic_nonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Number
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Number
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Number
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Number
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Number
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Number
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorAggregatedReporting

    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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizer

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAkamaizerTag

    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname string
    Specifies the replacement hostname for the tag to use.
    scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    include_tags_attribute 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.
    tags_attribute 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.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllHttpInCacheHierarchy

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowCloudletsOrigins

    Enabled bool
    Allows you to assign custom origin definitions referenced in sub-rules by cloudletsOrigin labels. If disabled, all sub-rules are ignored.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory boolean
    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.
    purgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_directory bool
    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_query_parameter str
    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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowDelete

    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsCacheKeySharing

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowHttpsDowngrade

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowOptions

    Enabled bool
    Set this to true to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowPatch

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowPost

    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled boolean
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_content_length bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled 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.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowPut

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAllowTransferEncoding

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAltSvcHeader

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge Integer
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the Alt-Svc header. The default max-age for an Alt-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.
    maxAge Number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritization

    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    alternateResponseCacheTtl Integer
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Integer
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.
    alternateResponseCacheTtl number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid string
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode boolean
    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_cache_ttl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled bool
    Activates the API Prioritization feature.
    is_shared_policy 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.
    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 GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    net_storage_path str
    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_code GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttled_status_code int
    Specifies the HTTP response code for requests that receive the alternate response.
    use_throttled_cp_code bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    use_throttled_status_code bool
    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.
    alternateResponseCacheTtl Number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage Property Map
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode Property Map
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.

    GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancer

    AllDownNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps List<GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes List<string>
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllDownNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps []GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerFailoverOriginMap
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes []string
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Integer
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode string
    Determines what to do if an origin fails.
    failoverOriginMaps GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerFailoverOriginMap[]
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes string[]
    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.
    failoverTitle 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.
    originCookieName string
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration string
    Sets how long it is before the cookie expires.
    stickinessExpirationDate string
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_net_storage GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    all_down_net_storage_file str
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    all_down_status_code str
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    all_down_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_cache_prefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cached_content_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Activates the Application Load Balancer Cloudlet.
    failover_attempts_threshold int
    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_maps Sequence[GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerFailoverOriginMap]
    Specifies a fixed set of failover mapping rules.
    failover_status_codes Sequence[str]
    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.
    origin_cookie_name str
    Specifies the name for your session cookie.
    specify_stickiness_cookie_domain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickiness_cookie_automatic_salt 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.
    stickiness_cookie_domain str
    Specifies the domain to track the stickiness cookie.
    stickiness_cookie_salt str
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickiness_cookie_set_http_only_flag bool
    Ensures the cookie is transmitted only over HTTP.
    stickiness_cookie_type 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_date str
    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.
    allDownNetStorage Property Map
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<Property Map>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerAllDownNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorApplicationLoadBalancerFailoverOriginMap

    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds List<string>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds []string
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds string[]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    from_origin_id str
    Specifies the origin whose failure triggers the mapping rule.
    to_origin_ids Sequence[str]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.

    GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentation

    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain string
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType string
    Specifies when the segmentation cookie expires.
    populationDuration string
    Specifies the lifetime of the segmentation cookie.
    populationRefresh boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    population_cookie_automatic_salt 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.
    population_cookie_domain str
    Specifies the domain to track the population cookie.
    population_cookie_include_rule_name bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    population_cookie_salt str
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    population_cookie_type 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.
    segment_tracking_cookie_name str
    This cookie name specifies the name of the segmentation rule.
    segment_tracking_custom_header str
    This custom HTTP header specifies the name of the segmentation rule.
    segment_tracking_method str
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segment_tracking_query_param str
    This query parameter specifies the name of the segmentation rule.
    segment_tracking_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specify_population_cookie_domain 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorAudienceSegmentationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorAutoDomainValidation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorBaseDirectory

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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/.

    GetPropertyRulesBuilderRulesV20240109BehaviorBossBeaconing

    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses List<string>
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses []string
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern string
    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.
    conditionalHttpStatuses string[]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency string
    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.
    forwardType 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.
    requestType string
    Specify when to trigger a beacon.
    samplingFrequency string
    Specifies a sampling frequency or disables beacons.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_pattern str
    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_statuses Sequence[str]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditional_sampling_frequency str
    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.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorBreadcrumbs

    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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 opposite ak-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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorBreakConnection

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorBrotli

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheError

    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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and 504 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 to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheId

    Elements List<string>
    Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    Specifies the name of the variable you want to include in the cache key.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyIgnoreCase

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyQueryParams

    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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheKeyRewrite

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey string
    Specifies the new cache key path as an alphanumeric value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCachePost

    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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    templateUuid string
    This option is for internal usage only.
    useBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheRedirect

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheTag

    Locked bool
    Indicates 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCacheTagVisible

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCaching

    Behavior string
    Specify the caching option.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    cacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl string
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache boolean
    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 live ttl to zero seconds.
    honorNoStore boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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_directives str
    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_support bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-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_age bool
    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 the max-age directive and the defaultTtl setting.
    honor_must_revalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honor_no_cache bool
    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 live ttl to zero seconds.
    honor_no_store bool
    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_revalidate bool
    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_maxage 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 the max-age directive and the defaultTtl 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.

    GetPropertyRulesBuilderRulesV20240109BehaviorCentralAuthorization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorChaseRedirects

    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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorClientCertificateAuth

    ClientCertificateAttributes List<string>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ClientCertificateAttributes []string
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes string[]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    client_certificate_attributes Sequence[str]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enable_client_certificate_validation_status bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enable_complete_client_certificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked bool
    Indicates that your 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.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorClientCharacteristics

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCloudInterconnects

    CloudLocations 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudLocations []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapper

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCloudWrapperAdvanced

    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_map str
    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.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCommonMediaClientData

    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_cmcd_segment_prefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked bool
    Indicates that your 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.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorConditionalOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorConstructResponse

    Body string
    HTML response of up to 2000 characters to send to the end-user client.
    Enabled bool
    Serves the custom response.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Integer
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode number
    The HTTP response code to send to the end-user client.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Number
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristics

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsAmd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom double
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom double
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom float64
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom float64
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Integer
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Integer
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Double
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Double
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationDashCustom number
    Customizes the number of seconds for the segment.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom number
    Customizes the number of seconds for the fragment.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationHlsCustom number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom number
    Customizes the number of seconds for the fragment.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_dash_custom int
    Customizes the number of seconds for the segment.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hds_custom int
    Customizes the number of seconds for the fragment.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_hls_custom float
    Customizes the number of seconds for the segment.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_duration_smooth_custom float
    Customizes the number of seconds for the fragment.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Number
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Number
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsDd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLargeFile

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdLive

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentCharacteristicsWsdVod

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentPrePosition

    Enabled bool
    Enables the Content PrePosition behavior.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation string
    sourceType string
    targets string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorContentTargetingProtection

    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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains List<string>
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses []string
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses []string
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains []string
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled boolean
    Enables the Content Targeting feature.
    geoProtectionMode string
    Specifies how to handle requests.
    geoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses string[]
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode string
    Specifies how to handle requests.
    ipProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl string
    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.
    overrideIpAddresses string[]
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains string[]
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode string
    Specify the action to take.
    referrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_protection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enable_geo_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_ip_protection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enable_ip_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_referrer_protection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enable_referrer_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enabled bool
    Enables the Content Targeting feature.
    geo_protection_mode str
    Specifies how to handle requests.
    geo_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geo_redirect_url str
    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_mode str
    Specifies how to handle requests.
    ip_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ip_redirect_url str
    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_addresses Sequence[str]
    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_mode str
    Specify the action to take.
    referrer_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrer_redirect_url str
    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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCorsSupport

    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders []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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflight_max_age str
    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.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorCustomBehavior

    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDatastream

    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames List<string>
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames []string
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Integer
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled boolean
    Enables 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.
    logEnabled boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames string[]
    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.
    logStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage number
    Specifies the percentage of log data you want to collect for this property.
    streamType string
    Specify the DataStream type.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collect_midgress_traffic bool
    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_names Sequence[str]
    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_title str
    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.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Number
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcp

    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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.
    namespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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 the IoT 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthHmacTransformation

    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm string
    Specifies the hash algorithm.
    hashConversionKey string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_algorithm str
    Specifies the hash algorithm.
    hash_conversion_key str
    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.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthRegexTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthSubstringTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpAuthVariableExtractor

    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField string
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_auth_processing_variable_id str
    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.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpDefaultAuthzGroups

    GroupNames 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    GroupNames []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpDevRelations

    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDcpRealTimeAuth

    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname boolean
    Extracts a hostname from JWT.
    extractJurisdiction boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDeliveryReceipt

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDenyAccess

    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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDenyDirectFailoverAccess

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicCacheId

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDeviceCharacteristicHeader

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDnsAsyncRefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorDnsPrefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorDowngradeProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDownloadCompleteMarker

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDownloadNotification

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDownstreamCache

    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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 a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.

    GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorDynamicThroughtputOptimizationOverride

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorDynamicWebContent

    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_monitoring bool
    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.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEcmsBulkUpload

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDatabase

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern string
    Specifies the regular expression that matches the database name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEcmsDataset

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEcmsObjectKey

    Locked bool
    Indicates 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeConnect

    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements List<string>
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements []string
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines string
    Specifies the maximum number of lines to include in each log.
    aggregateSize string
    Specifies the log's maximum size.
    aggregateTime string
    Specifies how often logs are generated.
    apiConnector string
    Describes the API connector type.
    apiDataElements string[]
    Specifies the data set to log.
    destinationHostname string
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings boolean
    When enabled, overrides default log settings.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_elements Sequence[str]
    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_settings bool
    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.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenter

    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules List<GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules []GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenterFailoverRule
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description string
    Provides a description for the ELB data center, for your own reference.
    enableFailover boolean
    Allows you to specify failover rules.
    failoverRules GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenterFailoverRule[]
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_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[GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenterFailoverRule]
    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 the edgeLoadBalancingOrigin 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.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<Property Map>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingDataCenterFailoverRule

    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname string
    The hostname of the data center to fail over to.
    modifyRequest boolean
    Allows you to modify the request's hostname or path.
    overrideHostname 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.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeLoadBalancingOrigin

    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description string
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description str
    Provides a description for the ELB origin, for your own reference.
    enable_session_persistence bool
    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 the edgeLoadBalancingDataCenter 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_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.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeOriginAuthorization

    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookie_name 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirector

    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy 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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeRedirectorCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeScape

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeSideIncludes

    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets List<string>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets []string
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection boolean
    Denies attempts to inject ESI code.
    enableViaHttp boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled boolean
    Enables ESI processing.
    i18nCharsets string[]
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_http bool
    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 and ISO-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_ip bool
    Allows edge servers to pass the client IP header to the ESI processor.
    pass_set_cookie 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.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEdgeWorker

    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId string
    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.
    mPulse boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_worker str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edge_worker_id str
    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.
    m_pulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    m_pulse_information str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    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.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEnforceMtlsSettings

    CertificateAuthoritySets List<string>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateAuthoritySets []string
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets string[]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_authority_sets Sequence[str]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enable_auth_set bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enable_deny_request bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enable_ocsp_status bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked bool
    Indicates that your 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.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedAkamaiProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorEnhancedProxyDetection

    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction string
    Specifies how to field the proxy request.
    bestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction string
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy boolean
    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.
    detectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode string
    Specifies how to field the proxy request.
    enabled boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment boolean
    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.
    hostingProvider 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.
    publicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter string
    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_action str
    Specifies how to field the proxy request.
    best_practice_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_anonymous_vpn bool
    This enables detection of requests from anonymous VPNs.
    detect_anonymous_vpn_action str
    Specifies how to field anonymous VPN requests.
    detect_anonymous_vpn_redirecturl str
    This specifies the URL to which to redirect anonymous VPN requests.
    detect_hosting_provider bool
    This detects requests from a hosting provider.
    detect_hosting_provider_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detect_hosting_provider_redirecturl str
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detect_public_proxy bool
    This enables detection of requests from public proxies.
    detect_public_proxy_action str
    Specifies how to field public proxy requests.
    detect_public_proxy_redirecturl str
    This specifies the URL to which to redirect public proxy requests.
    detect_residential_proxy bool
    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_proxy_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detect_residential_proxy_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_smart_dns_proxy bool
    This enables detection of requests from smart DNS proxies.
    detect_smart_dns_proxy_action str
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detect_smart_dns_proxy_redirecturl str
    This specifies the URL to which to redirect DNS proxy requests.
    detect_tor_exit_node bool
    This enables detection of requests from Tor exit nodes.
    detect_tor_exit_node_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detect_tor_exit_node_redirecturl str
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detect_vpn_data_center bool
    This enables detection of requests from VPN data centers.
    detect_vpn_data_center_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detect_vpn_data_center_redirecturl str
    This specifies the URL to which to redirect requests from VPN data centers.
    enable_configuration_mode str
    Specifies how to field the proxy request.
    enabled bool
    Applies GeoGuard proxy detection.
    forward_header_enrichment bool
    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_proxy 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.
    tor_exit_node 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.
    vpn_data_center str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorEpdForwardHeaderEnrichment

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFailAction

    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20240109BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20240109BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20240109BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Integer
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Integer
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Integer
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride boolean
    cexCustomPath boolean
    Specifies a custom path.
    cexHostname string
    Specifies a hostname.
    cexPath string
    Specifies a custom path.
    contentCustomPath boolean
    Specifies a custom redirect path.
    contentHostname string
    Specifies the static hostname for the alternate redirect.
    contentPath string
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath boolean
    Allows you to modify the original requested path.
    dynamicMethod string
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20240109BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath boolean
    Uses the redirectPath to customize a new path.
    redirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType string
    Whether to preserve or customize the hostname.
    redirectMethod number
    Specifies the HTTP response code.
    redirectPath string
    Specifies a new path.
    saasCnameEnabled boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    saasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode number
    Assigns a new HTTP status code to the failure response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_parent_override bool
    cex_custom_path bool
    Specifies a custom path.
    cex_hostname str
    Specifies a hostname.
    cex_path str
    Specifies a custom path.
    content_custom_path bool
    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 GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamic_custom_path bool
    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_hostname GetPropertyRulesBuilderRulesV20240109BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    net_storage_path str
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserve_query_string bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol str
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirect_custom_path bool
    Uses the redirectPath to customize a new path.
    redirect_hostname str
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirect_hostname_type str
    Whether to preserve or customize the hostname.
    redirect_method int
    Specifies the HTTP response code.
    redirect_path str
    Specifies a new path.
    saas_cname_enabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saas_cname_level int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saas_query_string str
    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.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode Property Map
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname Property Map
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Number
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Number
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorFailActionCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorFailActionNetStorageHostname

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240109BehaviorFailoverBotManagerFeatureCompatibility

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFastInvalidate

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFips

    Enable bool
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    enable Boolean
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketing

    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlus

    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorFirstPartyMarketingPlusCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewrite

    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorForwardRewriteCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorG2oheader

    CustomSignStrings List<string>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    CustomSignStrings []string
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Integer
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customSignStrings string[]
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled boolean
    Enables the g2o verification behavior.
    encodingVersion number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked boolean
    Indicates 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.
    secretKey string
    Specifies the shared secret key.
    signedHeader string
    Specifies the name of the header containing encrypted request data.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_strings Sequence[str]
    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 through 5.
    locked bool
    Indicates 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_sign_string bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorGlobalRequestNumber

    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption string
    Specifies how to report the GRN value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorGraphqlCaching

    Advanced string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors boolean
    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.
    operationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_with_errors bool
    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_body_parameter_name str
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operations_url_query_parameter_name str
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    post_request_processing_error_handling str
    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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorGzipResponse

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorHdDataAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorHealthDetection

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects 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 of retryCount.
    retryCount Integer
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 of retryCount.
    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.
    maximumReconnects Number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount Number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorHsafEipBinding

    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Integer
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Integer
    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.
    templateUuid 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.
    customExtractedSerial boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue number
    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.
    templateUuid 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_serial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hash_max_value int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hash_min_value int
    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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Number
    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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorHttp2

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorHttp3

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorHttpStrictTransportSecurity

    Enable bool
    Applies HSTS to this set of requests.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Integer
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains boolean
    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.
    maxAge 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.
    redirectStatusCode number
    Specifies a response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_domains bool
    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_code int
    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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Number
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorHttpToHttpsUpgrade

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImOverride

    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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters List<string>
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters []string
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.
    excludeAllQueryParameters boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters string[]
    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.
    policyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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_query_parameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excluded_query_parameters Sequence[str]
    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_mvar str
    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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManager

    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    applyBestFileType Boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformed
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String
    applyBestFileType boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformed
    enabled boolean
    imageSet 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.
    policySetType string
    resize boolean
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet string
    apply_best_file_type bool
    cp_code_original GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginal
    cp_code_transformed GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformed
    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_type str
    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
    applyBestFileType Boolean
    cpCodeOriginal Property Map
    cpCodeTransformed Property Map
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String

    GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManager

    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    api_reference_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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_default str
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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_region str
    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_policy_set bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal Property Map
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideo

    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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_default str
    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_region str
    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_policy_set bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal Property Map
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorInclude

    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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorInstant

    CustomLinkRelations List<string>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions List<string>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLinkRelations []string
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions []string
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations string[]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions string[]
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_relations Sequence[str]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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 the tieredDistribution 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_store bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetch_no_store_extensions Sequence[str]
    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.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorInstantConfig

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimization

    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching string
    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.
    maximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid string
    This option is for internal usage only.
    useVersioning boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_object_caching str
    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 or GB. 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 or GB.
    template_uuid str
    This option is for internal usage only.
    use_versioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    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.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorLargeFileOptimizationAdvanced

    Enabled bool
    Enables the file optimization behavior.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Integer
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Integer
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest number
    The number of POC fragments to prefetch during the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or GB suffix.
    prefetch_after_request int
    The number of POC fragments to prefetch after the request.
    prefetch_during_request int
    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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Number
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRate

    BitrateTables List<GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables List<GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BitrateTables []GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateBitrateTable
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables []GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateThresholdTable
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables List<GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables List<GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateBitrateTable[]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid string
    This option is for internal usage only.
    thresholdTables GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateThresholdTable[]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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[GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateBitrateTable]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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[GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateThresholdTable]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    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.
    bitrateTables 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 numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables 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 numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateBitrateTable

    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue double
    The numeric indicator of the download rate.
    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue float64
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Double
    The numeric indicator of the download rate.
    bitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue number
    The numeric indicator of the download rate.
    bitrate_unit str
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrate_value float
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Number
    The numeric indicator of the download rate.

    GetPropertyRulesBuilderRulesV20240109BehaviorLimitBitRateThresholdTable

    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Integer
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue 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, or BYTES of the file size.
    threshold_value int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Number
    The numeric indicator of the minimum file size or elapsed download time.

    GetPropertyRulesBuilderRulesV20240109BehaviorLogCustom

    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_field str
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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_log_field bool
    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.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMPulse

    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    apiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid string
    This option is for internal usage only.
    titleOptional 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}}". See Configuration 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorManifestPersonalization

    Enabled bool
    Enables the Manifest Personalization feature.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges string
    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.
    hlsFilterInBitrates string
    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.
    hlsMode string
    Applies with hlsEnabled on.
    hlsPreferredBitrate string
    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.
    hlsQueryParamEnabled boolean
    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.
    hlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_debug_headers bool
    Includes additional Akamai-Manifest-Personalization and Akamai-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_in_bitrate_ranges str
    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_in_bitrates str
    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_bitrate str
    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_param_enabled bool
    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_param_secret_key str
    Specifies a primary key as a token to accompany the request.
    hls_query_param_transition_key str
    Specifies a transition key as a token to accompany the request.
    hls_show_advanced bool
    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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorManifestRerouting

    Locked bool
    Indicates 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorManualServerPush

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMediaAcceleration

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMediaAccelerationQuicOptout

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMediaClient

    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    beaconId 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.
    templateUuid string
    This option is for internal usage only.
    useHybridHttpUdp boolean
    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_http_udp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.

    GetPropertyRulesBuilderRulesV20240109BehaviorMediaFileRetrievalOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMediaOriginFailover

    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes []string
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes []string
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Integer
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Integer
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Integer
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse boolean
    When enabled, caches the error response.
    cacheWindow string
    This sets error response's TTL.
    clientResponseCode string
    Specifies the response code served to the client.
    detectObjectUnavailable boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost string
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery string
    This sets the recovery option.
    objectUnavailableRedirectMethod number
    Specifies a redirect response code.
    objectUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit string
    Sets how many times to retry.
    originUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost string
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath string
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath boolean
    Modifies the request path.
    originUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery string
    This sets the recovery option.
    originUnavailableRedirectMethod number
    Specifies either a redirect response code.
    originUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit string
    Sets how many times to retry.
    originUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost string
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath boolean
    Modifies the request path.
    originUnresponsiveProtocol string
    Specifies which protocol to use.
    originUnresponsiveRecovery string
    This sets the recovery option.
    originUnresponsiveRedirectMethod number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit string
    Sets how many times to retry.
    otherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response bool
    When enabled, caches the error response.
    cache_window str
    This sets error response's TTL.
    client_response_code str
    Specifies the response code served to the client.
    detect_object_unavailable bool
    Allows you to configure failover settings when the origin has content errors.
    detect_object_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    detect_origin_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    detect_origin_unresponsive_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.
    object_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    object_unavailable_backup_host str
    This specifies the origin hostname.
    object_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    object_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    object_unavailable_change_protocol bool
    Changes the request protocol.
    object_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    object_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    object_unavailable_modified_path str
    This specifies the path to form the new URL.
    object_unavailable_modify_request_path bool
    Enabling this allows you to modify the request path.
    object_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    object_unavailable_recovery str
    This sets the recovery option.
    object_unavailable_redirect_method int
    Specifies a redirect response code.
    object_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when there are content errors.
    object_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unavailable_backup_host str
    This specifies the origin hostname.
    origin_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unavailable_change_protocol bool
    Modifies the request protocol.
    origin_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    origin_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unavailable_modified_path str
    This specifies the path to form the new URL.
    origin_unavailable_modify_request_path bool
    Modifies the request path.
    origin_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    origin_unavailable_recovery str
    This sets the recovery option.
    origin_unavailable_redirect_method int
    Specifies either a redirect response code.
    origin_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when the origin responds with errors.
    origin_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unresponsive_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unresponsive_backup_host str
    This specifies the origin hostname.
    origin_unresponsive_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unresponsive_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unresponsive_change_protocol bool
    This allows you to change the request protocol.
    origin_unresponsive_detection_level str
    Specify the level of response to slow origin connections.
    origin_unresponsive_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unresponsive_modified_path str
    This specifies the path to form the new URL.
    origin_unresponsive_modify_request_path bool
    Modifies the request path.
    origin_unresponsive_protocol str
    Specifies which protocol to use.
    origin_unresponsive_recovery str
    This sets the recovery option.
    origin_unresponsive_redirect_method int
    Specifies the redirect response code.
    origin_unresponsive_retry_limit str
    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.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Number
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Number
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMetadataCaching

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorMobileSdkPerformance

    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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to_origin bool
    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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingRequestHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Supplies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Supplies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorModifyIncomingResponseHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Specifies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingRequestHeader

    Action string
    Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies an HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorModifyOutgoingResponseHeader

    Action string
    Either ADD or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies the new HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies the new HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorModifyViaHeader

    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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption string
    Specify how you want to handle the header.
    renameHeaderTo string
    Specifies a new name to replace the existing Via header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to str
    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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorOrigin

    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities List<GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthority>
    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.
    CustomCertificates List<GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificate>
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues List<string>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20240109BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities List<string>
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities []GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthority
    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.
    CustomCertificates []GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificate
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues []string
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20240109BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities []string
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities List<GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthority>
    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.
    customCertificates List<GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificate>
    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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Integer
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort 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. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20240109BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Integer
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    compress boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthority[]
    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.
    customCertificates GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificate[]
    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.
    customForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues string[]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin string
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20240109BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor string
    Specifies which certificate to trust.
    originId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace string
    Specifies replacement text for what saasRegex matches.
    saasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    saasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities string[]
    templateUuid string
    This option is for internal usage only.
    tls13Support boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting boolean
    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.
    trueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey boolean
    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.
    verificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cache_key_hostname str
    Specifies the hostname to use when forming a cache key.
    compress bool
    Enables gzip compression for non-NetStorage origins.
    custom_certificate_authorities Sequence[GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthority]
    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[GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificate]
    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_host_header str
    This specifies the name of the custom host header the edge server should pass to the origin.
    custom_valid_cn_values Sequence[str]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enable_true_client_ip bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forward_host_header str
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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. See Secure 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.
    max_tls_version str
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    min_tls_version str
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin str
    This specifies the media's origin server.
    net_storage GetPropertyRulesBuilderRulesV20240109BehaviorOriginNetStorage
    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_to_honor str
    Specifies which certificate to trust.
    origin_id str
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id 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.
    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_enabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saas_cname_level int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saas_query_string str
    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_enabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standard_certificate_authorities Sequence[str]
    template_uuid str
    This option is for internal usage only.
    tls13_support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tls_version_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    true_client_ip_client_setting bool
    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_ip_header str
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    use_unique_cache_key bool
    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.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities 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.
    customCertificates 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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort Number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage Property Map
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristics

    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings List<string>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings []string
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Integer
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    accessKeyEncryptedStorage boolean
    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.
    adcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod string
    Specifies the authentication method.
    authenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion string
    awsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings string[]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo string
    Provides a region used by Akamai Direct Connection.
    encodingVersion number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService string
    gcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag boolean
    locked boolean
    Indicates 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.
    originLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag boolean
    roleArn string
    secretKey string
    Specifies the shared secret key.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    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_encrypted_storage bool
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    aws_access_key_id str
    Specifies active access key ID linked to your AWS account.
    aws_access_key_version_guid str
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    aws_ar_region str
    aws_host str
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    aws_region str
    This specifies the AWS region code of the location where your bucket resides.
    aws_secret_access_key str
    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_strings Sequence[str]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    direct_connect_geo str
    Provides a region used by Akamai Direct Connection.
    encoding_version int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    end_point_service str
    gcs_access_key_version_guid str
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcs_hmac_key_access_id str
    Specifies the active access ID linked to your Google account.
    gcs_hmac_key_secret str
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostname_tag bool
    locked bool
    Indicates 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.
    origin_location_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    property_id_tag bool
    role_arn str
    secret_key str
    Specifies the shared secret key.
    template_uuid str
    This option is for internal usage only.
    use_custom_sign_string bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCharacteristicsWsd

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificate

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthority

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthorityIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateAuthoritySubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginCustomCertificateSubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryMethod

    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode string
    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.
    recoveryMethod string
    Specifies the recovery method.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_code str
    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.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginFailureRecoveryPolicy

    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Integer
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Integer
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Integer
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    binaryEquivalentContent boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval number
    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.
    monitorOriginResponsiveness boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    tuningParameters 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_content bool
    Synchronizes content between the primary and backup origins, byte for byte.
    enable_ip_avoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled bool
    Activates and configures a recovery policy.
    ip_avoidance_error_threshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ip_avoidance_retry_interval int
    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_responsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitor_response_codes1s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes2s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes3s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitor_status_codes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes1_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes1_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes1_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes2_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes2_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes2_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes3_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes3_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes3_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_custom_timeout int
    Specify a custom timeout, from 1 to 10 seconds.
    origin_responsiveness_enable_recovery bool
    Enables a recovery action for a specific failure condition.
    origin_responsiveness_enable_retry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    origin_responsiveness_monitoring str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    origin_responsiveness_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_timeout str
    The timeout threshold that triggers a retry or recovery action.
    status_code_monitoring1 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring2 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring3 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.
    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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Number
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginIpAcl

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorOriginNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240109BehaviorPermissionsPolicy

    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives List<string>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives []string
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives string[]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_list str
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissions_policy_directives Sequence[str]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPersistentClientConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorPersistentConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorPersonallyIdentifiableInformation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPhasedRelease

    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes List<string>
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes []string
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes string[]
    Defines the set of failure codes that initiate the failover response.
    failoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate string
    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.
    populationRefresh boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    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_codes Sequence[str]
    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.
    is_shared_policy 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.
    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.
    population_cookie_type 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 effectively NONE.
    population_duration str
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    population_expiration_date str
    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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPhasedReleaseCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorPreconnect

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Preconnectlists List<string>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Preconnectlists []string
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists string[]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists Sequence[str]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPredictiveContentDelivery

    Enabled bool
    Enables the predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPredictivePrefetching

    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled boolean
    Enables the predictive prefetching 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracy_target str
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled bool
    Enables the predictive prefetching 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.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPrefetch

    Enabled bool
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPrefetchable

    Enabled bool
    Allows matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked bool
    Indicates that your 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorPrefreshCache

    Enabled bool
    Enables the cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval Integer
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    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 cache prefreshing 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.
    prefreshval Number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorQuality

    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Integer
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize string
    contentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType string
    country string
    deliveryFormat string
    deliveryType string
    downloadType string
    endUserLocation 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.
    maximumConcurrentUsers string
    objectSize string
    optimizeFor string
    originSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution string
    refreshRate string
    segmentDuration number
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audience_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalog_size str
    content_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    content_type str
    country str
    delivery_format str
    delivery_type str
    download_type str
    end_user_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.
    maximum_concurrent_users str
    object_size str
    optimize_for str
    origin_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularity_distribution str
    refresh_rate str
    segment_duration int
    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.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Number
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorQuicBeta

    Enabled bool
    Enables QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Integer
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quic_offer_percentage int
    The percentage of responses for which to allow QUIC sessions.
    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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRandomSeek

    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv boolean
    Enables random seek optimization in FLV files.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 boolean
    Enables random seek optimization in MP4 files.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv bool
    Enables random seek optimization in FLV files.
    locked bool
    Indicates 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
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 bool
    Enables random seek optimization in MP4 files.
    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.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRapid

    Enabled bool
    Enables API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorReadTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked bool
    Indicates that your 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.

    GetPropertyRulesBuilderRulesV20240109BehaviorRealTimeReporting

    Advanced bool
    Enables advanced options.
    BeaconSamplingPercentage double
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    BeaconSamplingPercentage float64
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage Double
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage number
    Specifies the percentage for sampling.
    enabled boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beacon_sampling_percentage float
    Specifies the percentage for sampling.
    enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked bool
    Indicates that your 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.
    advanced Boolean
    Enables advanced options.
    beaconSamplingPercentage Number
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRealUserMonitoring

    Enabled bool
    When enabled, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked bool
    Indicates that your 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRedirect

    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Integer
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol string
    Choose the protocol for the redirect URL.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    queryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode number
    Specify the redirect's response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination_hostname str
    Specify how to change the requested hostname, independently from the pathname.
    destination_hostname_other str
    Specifies the full hostname with which to replace the current hostname.
    destination_hostname_sibling str
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destination_hostname_subdomain str
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destination_path str
    Specify how to change the requested pathname, independently from the hostname.
    destination_path_other str
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destination_path_prefix str
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destination_path_suffix str
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destination_path_suffix_status str
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destination_protocol str
    Choose the protocol for the redirect URL.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobile_default_choice str
    Either specify a default response for mobile browsers, or customize your own.
    query_string str
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    response_code int
    Specify the redirect's 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.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Number
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRedirectplus

    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Integer
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled boolean
    Enables the redirect 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.
    responseCode number
    Assigns the status code for the redirect response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination str
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled bool
    Enables the redirect 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.
    response_code int
    Assigns the status code for the redirect 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.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Number
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRefererChecking

    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains List<string>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains []string
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains string[]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled boolean
    Enables the referer-checking 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.
    strict boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_children bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains Sequence[str]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled bool
    Enables the referer-checking 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.
    strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    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.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRemoveQueryParameter

    Locked bool
    Indicates 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 parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Parameters []string
    Specifies parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters List<String>
    Specifies parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters string[]
    Specifies parameters to remove from the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters Sequence[str]
    Specifies parameters to remove from 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.
    locked Boolean
    Indicates 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 parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRemoveVary

    Enabled bool
    When enabled, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked bool
    Indicates that your 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorReport

    Cookies List<string>
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Cookies []string
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies string[]
    This specifies the set of cookies names whose values you want to log.
    customLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage boolean
    Log the Accept-Language header.
    logCookies string
    Specifies the set of cookies to log.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    logEdgeIp boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost boolean
    Log the Host header.
    logReferer boolean
    Log the Referer header.
    logUserAgent boolean
    Log the User-Agent header.
    logXForwardedFor boolean
    Log any X-Forwarded-For request header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies Sequence[str]
    This specifies the set of cookies names whose values you want to log.
    custom_log_field str
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked bool
    Indicates 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_accept_language bool
    Log the Accept-Language header.
    log_cookies str
    Specifies the set of cookies to log.
    log_custom_log_field bool
    Whether to append additional custom data to each log line.
    log_edge_ip bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    log_host bool
    Log the Host header.
    log_referer bool
    Log the Referer header.
    log_user_agent bool
    Log the User-Agent header.
    log_x_forwarded_for bool
    Log any X-Forwarded-For request 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.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRequestClientHints

    AcceptChes List<string>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes List<string>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AcceptChes []string
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes []string
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes string[]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes string[]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accept_ches Sequence[str]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    accept_critical_ches Sequence[str]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your 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.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRequestControl

    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Integer
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Integer
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode number
    Specifies the response status code for the branded deny action.
    branded403Url string
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403_file str
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403_status_code int
    Specifies the response status code for the branded deny action.
    branded403_url str
    Specifies the redirect URL for the branded deny action.
    branded_deny_cache_ttl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enable_branded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled bool
    Enables the Request Control Cloudlet.
    is_shared_policy 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.
    net_storage GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    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.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Number
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage Property Map
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorRequestControlNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240109BehaviorRequestTypeMarker

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType string
    Specifies the type of request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    request_type str
    Specifies the type of 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizer

    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorResourceOptimizerExtendedCompatibility

    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures boolean
    Enables additional support and error handling.
    enabled boolean
    Enables the Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_all_features bool
    Enables additional support and error handling.
    enabled bool
    Enables the Resource Optimizer 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.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Integer
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode number
    The HTTP status code to replace the existing one.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    status_code int
    The HTTP status code to replace the existing one.
    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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Number
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorResponseCookie

    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled boolean
    Allows you to set a response cookie.
    expirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires string
    Sets various ways to specify when the cookie expires.
    format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid string
    This option is for internal usage only.
    type string
    What type of value to assign.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookie_name str
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    default_domain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    default_path bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain str
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration str
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled bool
    Allows you to set a response cookie.
    expiration_date str
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires str
    Sets various ways to specify when the cookie expires.
    format str
    When the type of cookie is set to UNIQUE, this sets the date format.
    http_only bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path str
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    same_site str
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    template_uuid str
    This option is for internal usage only.
    type str
    What type of value to assign.
    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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.

    GetPropertyRulesBuilderRulesV20240109BehaviorRestrictObjectCaching

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_size str
    Specifies a fixed maximum size of non-HTML content to cache.
    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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorReturnCacheStatus

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    response_header_name str
    Specifies the name of the HTTP header in which to report the cache status 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRewriteUrl

    Behavior string
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString boolean
    When enabled, retains the original path's query parameters.
    locked boolean
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keep_query_string bool
    When enabled, retains the original path's query parameters.
    locked bool
    Indicates 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 str
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    match_multiple bool
    When enabled, replaces all potential matches rather than only the first.
    match_regex str
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    target_path str
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    target_path_prepend str
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    target_regex str
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    target_url str
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorRumCustom

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Integer
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rum_group_name str
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rum_sample_rate int
    Specifies the percentage of web traffic to include in your RUM 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSaasDefinitions

    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    applicationAction string
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie string
    This specifies the name of the cookie that identifies the application.
    applicationQueryString string
    This names the query parameter that identifies the application.
    applicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction string
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie string
    This specifies the name of the cookie that identifies the customer.
    customerQueryString string
    This names the query parameter that identifies the customer.
    customerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid string
    This option is for internal usage only.
    usersAction string
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie string
    This specifies the name of the cookie that identifies the user.
    usersQueryString string
    This names the query parameter that identifies the user.
    usersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    application_action str
    Specifies the request component that identifies a SaaS application.
    application_cname_enabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    application_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    application_cookie str
    This specifies the name of the cookie that identifies the application.
    application_query_string str
    This names the query parameter that identifies the application.
    application_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    application_replace str
    Specifies a string to replace the request's application ID matched by applicationRegex.
    application_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customer_action str
    Specifies the request component that identifies a SaaS customer.
    customer_cname_enabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customer_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    customer_cookie str
    This specifies the name of the cookie that identifies the customer.
    customer_query_string str
    This names the query parameter that identifies the customer.
    customer_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customer_replace str
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customer_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.
    users_action str
    Specifies the request component that identifies a SaaS user.
    users_cname_enabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    users_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    users_cookie str
    This specifies the name of the cookie that identifies the user.
    users_query_string str
    This names the query parameter that identifies the user.
    users_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    users_replace str
    Specifies a string to replace the request's user ID matched by usersRegex.
    users_title 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudClient

    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader string
    Specifies where the Host header is defined.
    originType string
    Specifies where the origin is.
    sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_override_origin_cache_key bool
    When enabled, overrides the forwarding origin's cache key.
    connector_id str
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked bool
    Indicates 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_host_header str
    Specifies where the Host header is defined.
    origin_type str
    Specifies where the origin is.
    sf3c_origin_host str
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3c_origin_host_header str
    This specifies the hostname or IP address of the custom Salesforce host 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.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProvider

    Enabled bool
    Enables Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked bool
    Indicates that your 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSalesForceCommerceCloudProviderHostHeader

    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource string
    Specify where the host header derives 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    host_header_source str
    Specify where the host header derives 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.
    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.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSavePostDcaProcessing

    Enabled bool
    Enables processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    enabled Boolean
    Enables processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorScheduleInvalidation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod string
    Specifies how to invalidate the content.
    repeat boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start string
    The UTC date and time when matching cached content is to expire.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refresh_method str
    Specifies how to invalidate the content.
    repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeat_interval str
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start str
    The UTC date and time when matching cached content is to expire.
    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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorScriptManagement

    Enabled bool
    Enables the Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Integer
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid string
    This option is for internal usage only.
    timestamp number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker str
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    template_uuid str
    This option is for internal usage only.
    timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedContentProtection

    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts List<string>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles List<string>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts []string
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles []string
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Integer
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption boolean
    Whether to enable DASH Media Encryption.
    dataPayload boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled boolean
    Enables the segmented content protection behavior.
    fieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts string[]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles string[]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption boolean
    Enables HLS Segment Encryption.
    ip boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid string
    This option is for internal usage only.
    tokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dash_media_encryption bool
    Whether to enable DASH Media Encryption.
    data_payload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enable_token_in_uri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled bool
    Enables the segmented content protection behavior.
    field_carry_over str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    header_for_salts Sequence[str]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hls_master_manifest_files Sequence[str]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hls_media_encryption bool
    Enables HLS Segment Encryption.
    ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key str
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked bool
    Indicates 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_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revoked_list_id int
    Identifies the TokenAuth tokens to block from accessing your content.
    salt str
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    session_id bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    template_uuid str
    This option is for internal usage only.
    token_auth_hls_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_authentication_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_revocation_enabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    token_revocation_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transition_key str
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    use_advanced bool
    Allows you to specify advanced transitionKey and salt options.
    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.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaOptimization

    Behavior string
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType string
    The type of DVR.
    dvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime string
    This specifies when the live media event ends.
    liveType string
    The type of live 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.
    showAdvanced boolean
    Allows you to configure advanced media options.
    startTime string
    This specifies when the live media event begins.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvr_type str
    The type of DVR.
    dvr_window str
    Set the duration for your media, or 0m if a DVR is not required.
    enable_ull_streaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    end_time str
    This specifies when the live media event ends.
    live_type str
    The type of live 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.
    show_advanced bool
    Allows you to configure advanced media options.
    start_time str
    This specifies when the live media event begins.
    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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSegmentedMediaStreamingPrefetch

    Enabled bool
    Enables media stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked bool
    Indicates that your 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSetVariable

    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Integer
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Integer
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Integer
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Integer
    Specifies a maximum value for the generated integer.
    maxRandomNumber Integer
    Specifies the upper bound of the random number.
    min Integer
    Specifies a minimum value for the generated integer.
    minRandomNumber Integer
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Integer
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Integer
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm string
    Specifies the algorithm to apply.
    caseSensitive boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName string
    Specifies the certificate's content.
    cookieName string
    Specifies the name of the cookie to extract.
    deviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode string
    Specifies the encryption mode.
    endIndex number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation string
    This specifies from where to get the value.
    forceChars string
    Specifies characters to encode, possibly overriding the default set.
    formatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator string
    This specifies the type of value to generate.
    globalSubstitution boolean
    Replaces all matches in the string, not just the first.
    headerName string
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion string
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked boolean
    Indicates 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 number
    Specifies a maximum value for the generated integer.
    maxRandomNumber number
    Specifies the upper bound of the random number.
    min number
    Specifies a minimum value for the generated integer.
    minRandomNumber number
    Specifies the lower bound of the random number.
    nonce string
    Specifies the one-time number used for encryption.
    numberOfBytes number
    Specifies the number of random hex bytes to generate.
    operandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    separator string
    Specifies the character that separates pairs of values within the string.
    setCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    startIndex number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid string
    This option is for internal usage only.
    transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource string
    Determines how you want to set the value.
    variableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm str
    Specifies the algorithm to apply.
    case_sensitive bool
    Enabling this makes all matches case sensitive.
    certificate_field_name str
    Specifies the certificate's content.
    cookie_name str
    Specifies the name of the cookie to extract.
    device_profile str
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryption_key str
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryption_mode str
    Specifies the encryption mode.
    end_index int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    except_chars str
    Specifies characters not to encode, possibly overriding the default set.
    extract_location str
    This specifies from where to get the value.
    force_chars str
    Specifies characters to encode, possibly overriding the default set.
    format_string str
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator str
    This specifies the type of value to generate.
    global_substitution bool
    Replaces all matches in the string, not just the first.
    header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    hmac_algorithm str
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmac_key str
    Specifies the secret to use in generating the base64-encoded digest.
    initialization_vector str
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ip_version str
    Specifies the IP version under which a subnet mask generates.
    ipv4_prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6_prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    location_id str
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    max_random_number int
    Specifies the upper bound of the random number.
    min int
    Specifies a minimum value for the generated integer.
    min_random_number int
    Specifies the lower bound of the random number.
    nonce str
    Specifies the one-time number used for encryption.
    number_of_bytes int
    Specifies the number of random hex bytes to generate.
    operand_one str
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    param_name str
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    path_component_offset str
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prepend_bytes bool
    Specifies a number of random bytes to prepend to the key.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the value.
    regex str
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement str
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    response_header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    separator str
    Specifies the character that separates pairs of values within the string.
    set_cookie_name str
    Specifies the name of the origin's Set-Cookie response header.
    start_index int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    sub_string str
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    template_uuid str
    This option is for internal usage only.
    transform str
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    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_source str
    Determines how you want to set the value.
    variable_name str
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variable_value str
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Number
    Specifies a maximum value for the generated integer.
    maxRandomNumber Number
    Specifies the upper bound of the random number.
    min Number
    Specifies a minimum value for the generated integer.
    minRandomNumber Number
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Number
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.

    GetPropertyRulesBuilderRulesV20240109BehaviorSimulateErrorCode

    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType string
    Specifies the type of 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.
    templateUuid string
    This option is for internal usage only.
    timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    error_type str
    Specifies the type of 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.
    timeout str
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    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.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSiteShield

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20240109BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20240109BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20240109BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20240109BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20240109BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap Property Map
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorSiteShieldSsmap

    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String
    chinaCdnMap string
    hasMixedHosts boolean
    name string
    src string
    srmap string
    value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String

    GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigration

    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Integer
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Integer
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration number
    Specifies the number cache sharing days.
    cacheSharingStartTime string
    Specifies when to start cache sharing.
    enabled boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration number
    Specifies the number of days to migrate the cache.
    migrationFrom string
    What kind of traffic you're migrating from.
    migrationStartTime string
    Specifies when to start migrating the cache.
    tdLocation string
    Specifies the tieredDistribution location.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_https_downgrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allow_https_upgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cache_sharing_duration int
    Specifies the number cache sharing days.
    cache_sharing_start_time str
    Specifies when to start cache sharing.
    enabled bool
    Allows migration to Standard TLS.
    is_certificate_sni_only bool
    Sets whether your new certificate is SNI-only.
    is_tiered_distribution_used bool
    Allows you to align traffic to various tieredDistribution areas.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migration_duration int
    Specifies the number of days to migrate the cache.
    migration_from str
    What kind of traffic you're migrating from.
    migration_start_time str
    Specifies when to start migrating the cache.
    td_location str
    Specifies the tieredDistribution location.
    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.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Number
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Number
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorStandardTlsMigrationOverride

    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorStrictHeaderParsing

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strict_mode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers 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.
    valid_mode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.

    GetPropertyRulesBuilderRulesV20240109BehaviorSubCustomer

    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey boolean
    Allows you to set which query parameters are included in the cache key.
    caching boolean
    Modifies content caching rules.
    contentCompressor boolean
    Allows compression of subcustomer content.
    dynamicWebContent boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery boolean
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery boolean
    Enables delivery of media assets to subcustomers.
    origin boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid string
    This option is for internal usage only.
    tokenAuthorization boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    access_control bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cache_key bool
    Allows you to set which query parameters are included in the cache key.
    caching bool
    Modifies content caching rules.
    content_compressor bool
    Allows compression of subcustomer content.
    dynamic_web_content bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geo_location bool
    Sets subcustomers' location-based whitelists or blacklists.
    ip bool
    Sets subcustomers' IP whitelists or blacklists.
    large_file_delivery bool
    Enables large file delivery for subcustomers.
    live_video_delivery bool
    locked bool
    Indicates 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_path bool
    Modifies a subcustomer's request path.
    on_demand_video_delivery bool
    Enables delivery of media assets to subcustomers.
    origin bool
    Allows you to assign origin hostnames for customers.
    partner_domain_suffix str
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    refresh_content bool
    Allows you to reschedule when content validates for subcustomers.
    site_failover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    template_uuid str
    This option is for internal usage only.
    token_authorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    web_application_firewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.

    GetPropertyRulesBuilderRulesV20240109BehaviorSureRoute

    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride boolean
    customMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    testObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus string
    Specifies which hostname to use.
    type string
    Specifies the set of edge servers used to test routes.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_fcm_parent_override bool
    custom_map str
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    custom_stat_key str
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enable_custom_key bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    force_ssl_forward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    race_stat_ttl str
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    sr_download_link_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.
    test_object_url str
    Specifies the path and filename for your origin's test object to use in races to test routes.
    to_host str
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    to_host_status str
    Specifies which hostname to use.
    type str
    Specifies the set of edge servers used to test routes.
    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.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorTcpOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorTeaLeaf

    Enabled bool
    When enabled, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Integer
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibm_customer_id int
    The integer identifier for the IBM Tealeaf Connector account.
    limit_to_dynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistribution

    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked bool
    Indicates that your 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.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionAdvanced

    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall boolean
    enabled boolean
    When enabled, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method string
    policy string
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall bool
    enabled bool
    When enabled, activates tiered distribution.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method str
    policy str
    template_uuid str
    This option is for internal usage only.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorTieredDistributionCustomization

    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled boolean
    Enables custom maps.
    customMapName string
    Specifies the custom map name.
    hashAlgorithm string
    Specifies the hash algorithm.
    location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate string
    Specifies when the map migration should end.
    migrationStartDate string
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart string
    Specifies a numeric serial start value.
    templateUuid string
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapper_map_migration_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    custom_map_enabled bool
    Enables custom maps.
    custom_map_name str
    Specifies the custom map name.
    hash_algorithm str
    Specifies the hash algorithm.
    location str
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    map_migration_enabled bool
    Enables migration of the custom map to Cloud Wrapper.
    migration_end_date str
    Specifies when the map migration should end.
    migration_start_date str
    Specifies when to start migrating the map.
    migration_within_cw_maps_enabled bool
    Enables migration within Cloud Wrapper maps.
    serial_end str
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serial_start str
    Specifies a numeric serial start value.
    template_uuid str
    This option is for internal usage only.
    tier1_title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked bool
    Indicates that your 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.

    GetPropertyRulesBuilderRulesV20240109BehaviorUidConfiguration

    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled boolean
    Allows you to extract UIDs from client requests.
    extractLocation string
    Where to extract the UID value from.
    headerName string
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled bool
    Allows you to extract UIDs from client requests.
    extract_location str
    Where to extract the UID value from.
    header_name str
    This specifies the name of the HTTP header from which to extract the UID value.
    legal_text 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.
    query_parameter_name str
    This specifies the name of the query parameter from which to extract the UID 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 rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.

    GetPropertyRulesBuilderRulesV20240109BehaviorValidateEntityTag

    Enabled bool
    Enables the ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebToken

    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation string
    Specify from where to extract the JWT value.
    headerName string
    This specifies the name of the header from which to extract the JWT value.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extract_location str
    Specify from where to extract the JWT value.
    header_name str
    This specifies the name of the header from which to extract the JWT value.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates 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_name str
    This specifies the name of the query parameter from which to extract the JWT 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.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorVerifyJsonWebTokenForDcp

    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.
    authorizations string
    This specifies the authorization group name.
    clientId string
    This specifies the claim name.
    customHeader boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation string
    Specifies where to get the JWT value from.
    extractUserName boolean
    Allows you to extract the user name stored in the JWT.
    headerName string
    This specifies the name of the header to extract the JWT value from.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    userName string
    This specifies the user 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.
    authorizations str
    This specifies the authorization group name.
    client_id str
    This specifies the claim name.
    custom_header bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enable_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extract_authorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    extract_client_id bool
    Allows you to extract the client ID claim name stored in JWT.
    extract_location str
    Specifies where to get the JWT value from.
    extract_user_name bool
    Allows you to extract the user name stored in the JWT.
    header_name str
    This specifies the name of the header to extract the JWT value from.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primary_location str
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the JWT value.
    template_uuid str
    This option is for internal usage only.
    user_name str
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorVerifyTokenAuthorization

    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location string
    Specifies where to find the token in the incoming request.
    locationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid string
    This option is for internal usage only.
    transitionKey string
    Specifies a transition key as a hex value.
    useAdvanced boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm str
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escape_hmac_inputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    failure_response bool
    When enabled, sends an HTTP error when an authentication test fails.
    ignore_query_string bool
    Enabling this removes the query string from the URL used to form an encryption key.
    key str
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location str
    Specifies where to find the token in the incoming request.
    location_id str
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt str
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    template_uuid str
    This option is for internal usage only.
    transition_key str
    Specifies a transition key as a hex value.
    use_advanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    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.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoom

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorVirtualWaitingRoomWithEdgeWorkers

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritization

    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders List<string>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams List<string>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders []string
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams []string
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Integer
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Integer
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Integer
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Integer
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Visitor Prioritization 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.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp boolean
    Allows IP addresses to identify users.
    userIdentificationByParams boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders string[]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams string[]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowed_user_cookie_advanced bool
    Sets advanced configuration options for the allowed user's cookie.
    allowed_user_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowed_user_cookie_domain str
    Specifies a domain for an allowed user cookie.
    allowed_user_cookie_domain_type str
    Specify with allowedUserCookieAdvanced enabled.
    allowed_user_cookie_duration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowed_user_cookie_enabled bool
    Sets a cookie for users who have been allowed through to the site.
    allowed_user_cookie_http_only bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowed_user_cookie_label str
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowed_user_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowed_user_cookie_refresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowed_user_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Visitor Prioritization 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.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by the values of GET or POST request headers.
    user_identification_by_ip bool
    Allows IP addresses to identify users.
    user_identification_by_params bool
    When enabled, identifies users by the values of GET or POST request parameters.
    user_identification_key_cookie str
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    user_identification_key_headers Sequence[str]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    user_identification_key_params Sequence[str]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    user_identification_title 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.
    waiting_room_cache_ttl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waiting_room_cookie_advanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waiting_room_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waiting_room_cookie_domain str
    Specifies a domain for the waiting room cookie.
    waiting_room_cookie_domain_type str
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waiting_room_cookie_duration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waiting_room_cookie_enabled bool
    Enables a cookie to track a waiting room assignment.
    waiting_room_cookie_http_only bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waiting_room_cookie_label str
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waiting_room_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waiting_room_cookie_share_label bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waiting_room_cp_code GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waiting_room_directory str
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waiting_room_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_net_storage GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waiting_room_status_code int
    Specifies the response code for requests sent to the waiting room.
    waiting_room_use_cp_code bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode Property Map
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage Property Map
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies how to set the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifoStandalone

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationWaitingRoomNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240109BehaviorWatermarking

    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid string
    This option is for internal usage only.
    tokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 string
    Specifies a unique identifier for the first public key.
    verificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 string
    Specifies the first public key in its entirety.
    verificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    ab_variant_location str
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryption_password1 str
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryption_password2 str
    Provides the secondary password you can use to rotate passwords.
    decryption_password_id1 str
    Specifies a label that corresponds to the primary password.
    decryption_password_id2 str
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable bool
    Enables the watermarking 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.
    miscellaneous_settings_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    pattern_decryption_enable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    pattern_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signature_verification_enable bool
    When enabled, you can verify the signature in your watermarking token.
    template_uuid str
    This option is for internal usage only.
    token_signing_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    use_original_as_a bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    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_key_id1 str
    Specifies a unique identifier for the first public key.
    verification_key_id2 str
    Specifies a unique identifier for the optional second public key.
    verification_public_key1 str
    Specifies the first public key in its entirety.
    verification_public_key2 str
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.

    GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewall

    FirewallConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FirewallConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewall_configuration GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    firewallConfiguration Property Map
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorWebApplicationFirewallFirewallConfiguration

    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Integer
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId number
    fileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    config_id int
    file_name str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Number
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior

    GetPropertyRulesBuilderRulesV20240109BehaviorWebSockets

    Enabled bool
    Enables WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109BehaviorWebdav

    Enabled bool
    Enables the WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109Criterion

    AdvancedImMatch GetPropertyRulesBuilderRulesV20240109CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20240109CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20240109CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20240109CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20240109CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20240109CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20240109CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20240109CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20240109CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20240109CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20240109CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20240109CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20240109CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20240109CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20240109CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20240109CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20240109CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20240109CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20240109CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20240109CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20240109CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20240109CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20240109CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20240109CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20240109CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20240109CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20240109CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20240109CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20240109CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20240109CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20240109CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20240109CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20240109CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20240109CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20240109CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20240109CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20240109CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20240109CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20240109CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20240109CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240109CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240109CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    AdvancedImMatch GetPropertyRulesBuilderRulesV20240109CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20240109CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20240109CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20240109CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20240109CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20240109CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20240109CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20240109CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20240109CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20240109CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20240109CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20240109CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20240109CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20240109CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20240109CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20240109CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20240109CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20240109CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20240109CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20240109CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20240109CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20240109CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20240109CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20240109CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20240109CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20240109CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20240109CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20240109CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20240109CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20240109CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20240109CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20240109CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20240109CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20240109CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20240109CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20240109CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20240109CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20240109CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20240109CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20240109CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240109CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240109CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20240109CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20240109CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20240109CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20240109CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20240109CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20240109CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20240109CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20240109CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20240109CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20240109CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20240109CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20240109CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20240109CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20240109CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20240109CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20240109CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20240109CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20240109CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20240109CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20240109CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20240109CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20240109CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20240109CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20240109CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20240109CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20240109CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20240109CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20240109CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20240109CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20240109CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20240109CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20240109CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20240109CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20240109CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20240109CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20240109CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20240109CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20240109CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20240109CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20240109CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240109CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240109CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20240109CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20240109CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20240109CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20240109CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20240109CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20240109CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20240109CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20240109CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20240109CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20240109CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20240109CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20240109CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20240109CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20240109CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20240109CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20240109CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20240109CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20240109CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20240109CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20240109CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20240109CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20240109CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20240109CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20240109CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20240109CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20240109CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20240109CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20240109CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20240109CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20240109CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20240109CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20240109CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20240109CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20240109CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20240109CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20240109CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20240109CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20240109CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20240109CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20240109CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240109CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240109CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advanced_im_match GetPropertyRulesBuilderRulesV20240109CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20240109CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20240109CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    china_cdn_region GetPropertyRulesBuilderRulesV20240109CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    client_certificate GetPropertyRulesBuilderRulesV20240109CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    client_ip GetPropertyRulesBuilderRulesV20240109CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    client_ip_version GetPropertyRulesBuilderRulesV20240109CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudlets_origin GetPropertyRulesBuilderRulesV20240109CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    content_delivery_network GetPropertyRulesBuilderRulesV20240109CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    content_type GetPropertyRulesBuilderRulesV20240109CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    device_characteristic GetPropertyRulesBuilderRulesV20240109CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmd_auth_groups GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmd_auth_scheme GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmd_is_authenticated GetPropertyRulesBuilderRulesV20240109CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmd_username GetPropertyRulesBuilderRulesV20240109CriterionEcmdUsername
    This criterion can be used in includes.
    edge_workers_failure GetPropertyRulesBuilderRulesV20240109CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    file_extension GetPropertyRulesBuilderRulesV20240109CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20240109CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20240109CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    match_advanced GetPropertyRulesBuilderRulesV20240109CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    match_cp_code GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    match_response_code GetPropertyRulesBuilderRulesV20240109CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    match_variable GetPropertyRulesBuilderRulesV20240109CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadata_stage GetPropertyRulesBuilderRulesV20240109CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    origin_timeout GetPropertyRulesBuilderRulesV20240109CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20240109CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    query_string_parameter GetPropertyRulesBuilderRulesV20240109CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20240109CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recovery_config GetPropertyRulesBuilderRulesV20240109CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regular_expression GetPropertyRulesBuilderRulesV20240109CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    request_cookie GetPropertyRulesBuilderRulesV20240109CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    request_header GetPropertyRulesBuilderRulesV20240109CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    request_method GetPropertyRulesBuilderRulesV20240109CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    request_protocol GetPropertyRulesBuilderRulesV20240109CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    request_type GetPropertyRulesBuilderRulesV20240109CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    response_header GetPropertyRulesBuilderRulesV20240109CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    server_location GetPropertyRulesBuilderRulesV20240109CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20240109CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    token_authorization GetPropertyRulesBuilderRulesV20240109CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    user_agent GetPropertyRulesBuilderRulesV20240109CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    user_location GetPropertyRulesBuilderRulesV20240109CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    user_network GetPropertyRulesBuilderRulesV20240109CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variable_error GetPropertyRulesBuilderRulesV20240109CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtual_waiting_room_request GetPropertyRulesBuilderRulesV20240109CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitor_prioritization_request GetPropertyRulesBuilderRulesV20240109CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch Property Map
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket Property Map
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability Property Map
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion Property Map
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate Property Map
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp Property Map
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion Property Map
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin Property Map
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork Property Map
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType Property Map
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic Property Map
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups Property Map
    This criterion can be used in includes.
    ecmdAuthScheme Property Map
    This criterion can be used in includes.
    ecmdIsAuthenticated Property Map
    This criterion can be used in includes.
    ecmdUsername Property Map
    This criterion can be used in includes.
    edgeWorkersFailure Property Map
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension Property Map
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename Property Map
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname Property Map
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced Property Map
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode Property Map
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode Property Map
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable Property Map
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage Property Map
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout Property Map
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path Property Map
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter Property Map
    Matches query string field names or values. This criterion can be used in includes.
    random Property Map
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig Property Map
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression Property Map
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie Property Map
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod Property Map
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol Property Map
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType Property Map
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation Property Map
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time Property Map
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization Property Map
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent Property Map
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation Property Map
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork Property Map
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError Property Map
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest Property Map
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest Property Map
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.

    GetPropertyRulesBuilderRulesV20240109CriterionAdvancedImMatch

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the match's scope.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the match's scope.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionBucket

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage Integer
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage number
    Specifies the percentage of requests to match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage int
    Specifies the percentage of requests to match.
    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.
    percentage Number
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionCacheability

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    match_operator str
    Specifies the match's logic.
    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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_CACHE).

    GetPropertyRulesBuilderRulesV20240109CriterionChinaCdnRegion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionClientCertificate

    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforce_mtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    is_certificate_present bool
    Executes rule behaviors only if a client certificate authenticates requests.
    is_certificate_valid str
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked bool
    Indicates that your 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.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionClientIp

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    IP or CIDR block, for example: 71.92.0.0/14.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    useHeaders boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked bool
    Indicates 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_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    template_uuid str
    This option is for internal usage only.
    use_headers bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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.
    values Sequence[str]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.

    GetPropertyRulesBuilderRulesV20240109CriterionClientIpVersion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    useXForwardedFor boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked bool
    Indicates that your 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_x_forwarded_for bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.

    GetPropertyRulesBuilderRulesV20240109CriterionCloudletsOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The Cloudlets Origins identifier, limited to alphanumeric and underscore 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionContentDeliveryNetwork

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network string
    Match the network.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network str
    Match the network.
    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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionContentType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Content-Type response header value, for example text/html.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for all values.
    matchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Content-Type response header value, for example text/html.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for all values.
    match_operator str
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    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.
    values Sequence[str]
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.

    GetPropertyRulesBuilderRulesV20240109CriterionDeviceCharacteristic

    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues List<string>
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues []string
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Integer
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic string
    Aspect of the device or browser 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.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues string[]
    When the characteristic expects a string, this specifies the set of values.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue string
    When the characteristic expects a version number, this specifies it as a string.
    boolean_value bool
    When the characteristic expects a boolean value, this specifies the value.
    characteristic str
    Aspect of the device or browser 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_case_sensitive bool
    Sets a case-sensitive match for the stringValue field.
    match_wildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numeric_match_operator str
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numeric_value int
    When the characteristic expects a numeric value, this specifies the number.
    string_match_operator str
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    string_values Sequence[str]
    When the characteristic expects a string, this specifies the set of values.
    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.
    version_match_operator str
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    version_value str
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.

    GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthGroups

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked bool
    Indicates 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_operator 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.
    value str
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20240109CriterionEcmdAuthScheme

    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    auth_scheme 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.
    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.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionEcmdIsAuthenticated

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionEcmdUsername

    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    match_operator 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.
    value str
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20240109CriterionEdgeWorkersFailure

    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus string
    Specify execution status.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    exec_status str
    Specify execution status.
    locked bool
    Indicates that your 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.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionFileExtension

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.

    GetPropertyRulesBuilderRulesV20240109CriterionFilename

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the values field.
    matchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the values field.
    match_operator str
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    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.
    values Sequence[str]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.

    GetPropertyRulesBuilderRulesV20240109CriterionHostname

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked bool
    Indicates 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_operator str
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.

    GetPropertyRulesBuilderRulesV20240109CriterionMatchAdvanced

    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml string
    An XML string that closes the relevant block.
    description string
    A 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.
    openXml string
    An XML string that opens the relevant block.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    close_xml str
    An XML string that closes the relevant block.
    description str
    A 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.
    open_xml str
    An XML string that opens the relevant block.
    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.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to match the CP code, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240109CriterionMatchCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240109CriterionMatchResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A set of response codes to match, for example ["404","500"].
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator string
    Matches numeric range or a specified set of values.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A set of response codes to match, for example ["404","500"].
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    match_operator str
    Matches numeric range or a specified set of values.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    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.
    values Sequence[str]
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].

    GetPropertyRulesBuilderRulesV20240109CriterionMatchVariable

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues List<string>
    Specifies an array of matching strings.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues []string
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound string
    Specifies the range's numeric minimum value.
    matchCaseSensitive boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound string
    Specifies the range's numeric maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression string
    Specifies a single matching string.
    variableName string
    The name of the variable to match.
    variableValues string[]
    Specifies an array of matching strings.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound str
    Specifies the range's numeric minimum value.
    match_case_sensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    match_operator str
    The type of match, based on which you use different options to specify the match criteria.
    match_wildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound str
    Specifies the range's numeric maximum value.
    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_expression str
    Specifies a single matching string.
    variable_name str
    The name of the variable to match.
    variable_values Sequence[str]
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.

    GetPropertyRulesBuilderRulesV20240109CriterionMetadataStage

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Compares the current rule with the specified metadata stage.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked bool
    Indicates 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_operator str
    Compares the current rule with the specified metadata stage.
    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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.

    GetPropertyRulesBuilderRulesV20240109CriterionOriginTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specifies a single required ORIGIN_TIMED_OUT 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionPath

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of the values array.
    normalize boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of the values array.
    normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    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.
    values Sequence[str]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.

    GetPropertyRulesBuilderRulesV20240109CriterionQueryStringParameter

    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The value of the query field, for example, string in ?q=string.
    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.
    escapeValue boolean
    Matches when the value is URL-escaped.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName string
    The name of the query field, for example, q in ?q=string.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The value of the query field, for example, string in ?q=string.
    escape_value bool
    Matches when the value is URL-escaped.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the parameterName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameter_name str
    The name of the query field, for example, q in ?q=string.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.

    GetPropertyRulesBuilderRulesV20240109CriterionRandom

    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket Integer
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    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.
    bucket Number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionRecoveryConfig

    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    config_name str
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked bool
    Indicates that your 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.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionRegularExpression

    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive boolean
    Sets a case-sensitive regular expression 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.
    matchString string
    The string to match, typically the contents of a dynamic variable.
    regex string
    The regular expression (PCRE) to match against the string.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    case_sensitive bool
    Sets a case-sensitive regular expression 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_string str
    The string to match, typically the contents of a dynamic variable.
    regex str
    The regular expression (PCRE) to match against the string.
    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.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionRequestCookie

    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookie_name str
    The name of the cookie, for example, visitor in visitor:anon.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the cookieName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.

    GetPropertyRulesBuilderRulesV20240109CriterionRequestHeader

    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName string
    The name of the request header, for example Accept-Language.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    header_name str
    The name of the request header, for example Accept-Language.
    locked bool
    Indicates 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_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more 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.
    values Sequence[str]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.

    GetPropertyRulesBuilderRulesV20240109CriterionRequestMethod

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked bool
    Indicates 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_operator str
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.

    GetPropertyRulesBuilderRulesV20240109CriterionRequestProtocol

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked bool
    Indicates that your 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.

    GetPropertyRulesBuilderRulesV20240109CriterionRequestType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked bool
    Indicates 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_operator str
    Specifies whether the request IS or IS_NOT the type of specified 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.
    value str
    Specifies the type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.

    GetPropertyRulesBuilderRulesV20240109CriterionResponseHeader

    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName string
    The name of the response header, for example Content-Type.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator string
    Narrows the match according to various criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    header_name str
    The name of the response header, for example Content-Type.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_value bool
    When enabled, the match is case-sensitive for the value field.
    match_operator str
    Narrows the match according to various criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.

    GetPropertyRulesBuilderRulesV20240109CriterionServerLocation

    Continents List<string>
    Continent codes.
    Countries List<string>
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Continents []string
    Continent codes.
    Countries []string
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents string[]
    Continent codes.
    countries string[]
    ISO 3166-1 country codes, such as US or CN.
    locationType string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents Sequence[str]
    Continent codes.
    countries Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    location_type str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    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.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionTime

    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate string
    Sets the start of a time period.
    endDate string
    Sets the end of a fixed time period.
    lastingDate string
    Sets the start of a fixed time period.
    lastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies how to define the range of time.
    repeatBeginDate string
    Sets the start of the initial time period.
    repeatDuration string
    Sets the duration of each repeating time period.
    repeatInterval string
    Sets the time between each repeating time period's starting points.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    apply_daylight_savings_time bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    begin_date str
    Sets the start of a time period.
    end_date str
    Sets the end of a fixed time period.
    lasting_date str
    Sets the start of a fixed time period.
    lasting_duration str
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked bool
    Indicates 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_operator str
    Specifies how to define the range of time.
    repeat_begin_date str
    Sets the start of the initial time period.
    repeat_duration str
    Sets the duration of each repeating time period.
    repeat_interval str
    Sets the time between each repeating time period's starting points.
    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.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionTokenAuthorization

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Error match scope.
    StatusLists List<string>
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Error match scope.
    StatusLists []string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Error match scope.
    statusLists string[]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Error match scope.
    status_lists Sequence[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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionUserAgent

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    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.
    values Sequence[str]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).

    GetPropertyRulesBuilderRulesV20240109CriterionUserLocation

    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues List<string>
    Continent codes.
    CountryValues List<string>
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues []string
    Continent codes.
    CountryValues []string
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps string
    Specifies which IP addresses determine the user's location.
    continentValues string[]
    Continent codes.
    countryValues string[]
    ISO 3166-1 country codes, such as US or CN.
    field string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    check_ips str
    Specifies which IP addresses determine the user's location.
    continent_values Sequence[str]
    Continent codes.
    country_values Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    field str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    region_values Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionUserNetwork

    BandwidthValues List<string>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues List<string>
    NetworkValues List<string>
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BandwidthValues []string
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues []string
    NetworkValues []string
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues string[]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps string
    Specifies which IP addresses determine the user's network.
    field string
    The type of information 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.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues string[]
    networkValues string[]
    Any set of specific networks.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidth_values Sequence[str]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    check_ips str
    Specifies which IP addresses determine the user's network.
    field str
    The type of information 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    network_type_values Sequence[str]
    network_values Sequence[str]
    Any set of specific networks.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionVariableError

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames List<string>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames []string
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames string[]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    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_names Sequence[str]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.

    GetPropertyRulesBuilderRulesV20240109CriterionVirtualWaitingRoomRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CriterionVisitorPrioritizationRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240109CustomOverride

    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override
    name string
    The name of a custom override
    overrideId string
    The ID of a custom override
    name str
    The name of a custom override
    override_id str
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override

    GetPropertyRulesBuilderRulesV20240109Variable

    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable
    description string
    The description for a variable
    hidden boolean
    Whether a variable should be hidden
    name string
    The name of a variable
    sensitive boolean
    States whether a variable contains sensitive information
    value string
    The value for a variable
    description str
    The description for a variable
    hidden bool
    Whether a variable should be hidden
    name str
    The name of a variable
    sensitive bool
    States whether a variable contains sensitive information
    value str
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable

    GetPropertyRulesBuilderRulesV20240212

    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors List<GetPropertyRulesBuilderRulesV20240212Behavior>
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions List<GetPropertyRulesBuilderRulesV20240212Criterion>
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20240212CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables List<GetPropertyRulesBuilderRulesV20240212Variable>
    A list of variables for a rule
    Name string
    The name of a rule
    AdvancedOverride string
    XML metadata of the rule
    Behaviors []GetPropertyRulesBuilderRulesV20240212Behavior
    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
    CriteriaLocked bool
    States whether changes to 'criterion' objects are prohibited
    CriteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    Criterions []GetPropertyRulesBuilderRulesV20240212Criterion
    The list of criteria for a rule
    CustomOverride GetPropertyRulesBuilderRulesV20240212CustomOverride
    XML metadata of the rule
    IsSecure bool
    States whether a rule is secure
    TemplateLink string
    The template link for the rule
    TemplateUuid string
    The UUID of a rule template
    Uuid string
    The UUID of the rule
    Variables []GetPropertyRulesBuilderRulesV20240212Variable
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride String
    XML metadata of the rule
    behaviors List<GetPropertyRulesBuilderRulesV20240212Behavior>
    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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<GetPropertyRulesBuilderRulesV20240212Criterion>
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20240212CustomOverride
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid String
    The UUID of a rule template
    uuid String
    The UUID of the rule
    variables List<GetPropertyRulesBuilderRulesV20240212Variable>
    A list of variables for a rule
    name string
    The name of a rule
    advancedOverride string
    XML metadata of the rule
    behaviors GetPropertyRulesBuilderRulesV20240212Behavior[]
    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
    criteriaLocked boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy string
    States whether 'all' criteria need to match or 'any'
    criterions GetPropertyRulesBuilderRulesV20240212Criterion[]
    The list of criteria for a rule
    customOverride GetPropertyRulesBuilderRulesV20240212CustomOverride
    XML metadata of the rule
    isSecure boolean
    States whether a rule is secure
    templateLink string
    The template link for the rule
    templateUuid string
    The UUID of a rule template
    uuid string
    The UUID of the rule
    variables GetPropertyRulesBuilderRulesV20240212Variable[]
    A list of variables for a rule
    name str
    The name of a rule
    advanced_override str
    XML metadata of the rule
    behaviors Sequence[GetPropertyRulesBuilderRulesV20240212Behavior]
    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_satisfy str
    States whether 'all' criteria need to match or 'any'
    criterions Sequence[GetPropertyRulesBuilderRulesV20240212Criterion]
    The list of criteria for a rule
    custom_override GetPropertyRulesBuilderRulesV20240212CustomOverride
    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[GetPropertyRulesBuilderRulesV20240212Variable]
    A list of variables for a rule
    name String
    The name of a rule
    advancedOverride 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
    criteriaLocked Boolean
    States whether changes to 'criterion' objects are prohibited
    criteriaMustSatisfy String
    States whether 'all' criteria need to match or 'any'
    criterions List<Property Map>
    The list of criteria for a rule
    customOverride Property Map
    XML metadata of the rule
    isSecure Boolean
    States whether a rule is secure
    templateLink String
    The template link for the rule
    templateUuid 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

    GetPropertyRulesBuilderRulesV20240212Behavior

    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240212BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20240212BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20240212BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240212BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20240212BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20240212BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20240212BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20240212BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20240212BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20240212BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20240212BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20240212BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20240212BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20240212BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20240212BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20240212BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20240212BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20240212BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20240212BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20240212BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20240212BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20240212BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20240212BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20240212BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240212BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20240212BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20240212BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20240212BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20240212BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20240212BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20240212BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20240212BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20240212BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20240212BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20240212BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20240212BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20240212BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20240212BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240212BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20240212BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20240212BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20240212BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20240212BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20240212BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20240212BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20240212BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20240212BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20240212BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20240212BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20240212BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20240212BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20240212BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20240212BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20240212BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240212BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20240212BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20240212BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20240212BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20240212BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20240212BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20240212BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20240212BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20240212BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20240212BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240212BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240212BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20240212BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20240212BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20240212BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20240212BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20240212BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20240212BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20240212BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20240212BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20240212BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20240212BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240212BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20240212BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240212BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20240212BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20240212BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20240212BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240212BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20240212BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240212BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20240212BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20240212BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20240212BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20240212BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20240212BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240212BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20240212BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20240212BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20240212BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20240212BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20240212BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20240212BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20240212BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20240212BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20240212BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20240212BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20240212BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20240212BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20240212BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20240212BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20240212BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20240212BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20240212BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20240212BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20240212BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20240212BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20240212BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20240212BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20240212BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20240212BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20240212BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20240212BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20240212BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20240212BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20240212BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20240212BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20240212BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20240212BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20240212BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20240212BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20240212BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20240212BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20240212BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20240212BehaviorWebdav
    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.
    AdScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240212BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    AdaptiveAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    AdaptiveImageCompression GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    Advanced GetPropertyRulesBuilderRulesV20240212BehaviorAdvanced
    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.
    AggregatedReporting GetPropertyRulesBuilderRulesV20240212BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    Akamaizer GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    AkamaizerTag GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizerTag
    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.
    AllHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240212BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    AllowCloudletsOrigins GetPropertyRulesBuilderRulesV20240212BehaviorAllowCloudletsOrigins
    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.
    AllowDelete GetPropertyRulesBuilderRulesV20240212BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    AllowHttpsDowngrade GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsDowngrade
    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.
    AllowOptions GetPropertyRulesBuilderRulesV20240212BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    AllowPatch GetPropertyRulesBuilderRulesV20240212BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPost GetPropertyRulesBuilderRulesV20240212BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    AllowPut GetPropertyRulesBuilderRulesV20240212BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    AllowTransferEncoding GetPropertyRulesBuilderRulesV20240212BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    AltSvcHeader GetPropertyRulesBuilderRulesV20240212BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    ApiPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    ApplicationLoadBalancer GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancer
    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.
    AudienceSegmentation GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentation
    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.
    AutoDomainValidation GetPropertyRulesBuilderRulesV20240212BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    BaseDirectory GetPropertyRulesBuilderRulesV20240212BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    BossBeaconing GetPropertyRulesBuilderRulesV20240212BehaviorBossBeaconing
    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.
    Breadcrumbs GetPropertyRulesBuilderRulesV20240212BehaviorBreadcrumbs
    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.
    BreakConnection GetPropertyRulesBuilderRulesV20240212BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    Brotli GetPropertyRulesBuilderRulesV20240212BehaviorBrotli
    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.
    CacheError GetPropertyRulesBuilderRulesV20240212BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    CacheId GetPropertyRulesBuilderRulesV20240212BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    CacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    CacheKeyQueryParams GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyQueryParams
    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.
    CacheKeyRewrite GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyRewrite
    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.
    CachePost GetPropertyRulesBuilderRulesV20240212BehaviorCachePost
    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.
    CacheRedirect GetPropertyRulesBuilderRulesV20240212BehaviorCacheRedirect
    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.
    CacheTag GetPropertyRulesBuilderRulesV20240212BehaviorCacheTag
    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. The cacheTag 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.
    CacheTagVisible GetPropertyRulesBuilderRulesV20240212BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240212BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    CentralAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    ChaseRedirects GetPropertyRulesBuilderRulesV20240212BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    ClientCertificateAuth GetPropertyRulesBuilderRulesV20240212BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    ClientCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorClientCharacteristics
    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.
    CloudInterconnects GetPropertyRulesBuilderRulesV20240212BehaviorCloudInterconnects
    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.
    CloudWrapper GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    CloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapperAdvanced
    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.
    CommonMediaClientData GetPropertyRulesBuilderRulesV20240212BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    ConditionalOrigin GetPropertyRulesBuilderRulesV20240212BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    ConstructResponse GetPropertyRulesBuilderRulesV20240212BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    ContentCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristics
    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.
    ContentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsAmd
    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.
    ContentCharacteristicsDd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsDd
    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.
    ContentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLargeFile
    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.
    ContentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLive
    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.
    ContentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdVod
    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.
    ContentPrePosition GetPropertyRulesBuilderRulesV20240212BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    ContentTargetingProtection GetPropertyRulesBuilderRulesV20240212BehaviorContentTargetingProtection
    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.
    CorsSupport GetPropertyRulesBuilderRulesV20240212BehaviorCorsSupport
    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.
    CpCode GetPropertyRulesBuilderRulesV20240212BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    CustomBehavior GetPropertyRulesBuilderRulesV20240212BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    Datastream GetPropertyRulesBuilderRulesV20240212BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    Dcp GetPropertyRulesBuilderRulesV20240212BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    DcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    DcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthVariableExtractor
    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.
    DcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240212BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    DcpDevRelations GetPropertyRulesBuilderRulesV20240212BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    DcpRealTimeAuth GetPropertyRulesBuilderRulesV20240212BehaviorDcpRealTimeAuth
    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.
    DeliveryReceipt GetPropertyRulesBuilderRulesV20240212BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    DenyAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyAccess
    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.
    DenyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    DeviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicCacheId
    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.
    DeviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    DnsAsyncRefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    DnsPrefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsPrefresh
    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.
    DowngradeProtocol GetPropertyRulesBuilderRulesV20240212BehaviorDowngradeProtocol
    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.
    DownloadCompleteMarker GetPropertyRulesBuilderRulesV20240212BehaviorDownloadCompleteMarker
    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.
    DownloadNotification GetPropertyRulesBuilderRulesV20240212BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    DownstreamCache GetPropertyRulesBuilderRulesV20240212BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    DynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimization
    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.
    DynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimizationOverride
    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.
    DynamicWebContent GetPropertyRulesBuilderRulesV20240212BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    EcmsBulkUpload GetPropertyRulesBuilderRulesV20240212BehaviorEcmsBulkUpload
    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.
    EcmsDatabase GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    EcmsDataset GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDataset
    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.
    EcmsObjectKey GetPropertyRulesBuilderRulesV20240212BehaviorEcmsObjectKey
    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.
    EdgeConnect GetPropertyRulesBuilderRulesV20240212BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    EdgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingAdvanced
    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.
    EdgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenter
    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.
    EdgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingOrigin
    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.
    EdgeOriginAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    EdgeRedirector GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    EdgeScape GetPropertyRulesBuilderRulesV20240212BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    EdgeSideIncludes GetPropertyRulesBuilderRulesV20240212BehaviorEdgeSideIncludes
    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, or filename. 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.
    EdgeWorker GetPropertyRulesBuilderRulesV20240212BehaviorEdgeWorker
    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.
    EnforceMtlsSettings GetPropertyRulesBuilderRulesV20240212BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    EnhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedAkamaiProtocol
    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.
    EnhancedProxyDetection GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedProxyDetection
    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.
    EpdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240212BehaviorEpdForwardHeaderEnrichment
    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.
    FailAction GetPropertyRulesBuilderRulesV20240212BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    FailoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorFailoverBotManagerFeatureCompatibility
    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.
    FastInvalidate GetPropertyRulesBuilderRulesV20240212BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    Fips GetPropertyRulesBuilderRulesV20240212BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    FirstPartyMarketing GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    FirstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    ForwardRewrite GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    G2oheader GetPropertyRulesBuilderRulesV20240212BehaviorG2oheader
    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.
    GlobalRequestNumber GetPropertyRulesBuilderRulesV20240212BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    GraphqlCaching GetPropertyRulesBuilderRulesV20240212BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    GzipResponse GetPropertyRulesBuilderRulesV20240212BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    HdDataAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorHdDataAdvanced
    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.
    HealthDetection GetPropertyRulesBuilderRulesV20240212BehaviorHealthDetection
    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.
    HsafEipBinding GetPropertyRulesBuilderRulesV20240212BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    HttpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240212BehaviorHttpStrictTransportSecurity
    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.
    HttpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240212BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    ImOverride GetPropertyRulesBuilderRulesV20240212BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    ImageAndVideoManager GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManager
    This behavior can be used in includes.
    ImageManager GetPropertyRulesBuilderRulesV20240212BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    ImageManagerVideo GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    Include GetPropertyRulesBuilderRulesV20240212BehaviorInclude
    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.
    Instant GetPropertyRulesBuilderRulesV20240212BehaviorInstant
    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.
    InstantConfig GetPropertyRulesBuilderRulesV20240212BehaviorInstantConfig
    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.
    LargeFileOptimization GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    LargeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    LimitBitRate GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    LogCustom GetPropertyRulesBuilderRulesV20240212BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    MPulse GetPropertyRulesBuilderRulesV20240212BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    ManifestPersonalization GetPropertyRulesBuilderRulesV20240212BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    ManifestRerouting GetPropertyRulesBuilderRulesV20240212BehaviorManifestRerouting
    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.
    ManualServerPush GetPropertyRulesBuilderRulesV20240212BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    MediaAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    MediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240212BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    MediaClient GetPropertyRulesBuilderRulesV20240212BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    MediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240212BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    MediaOriginFailover GetPropertyRulesBuilderRulesV20240212BehaviorMediaOriginFailover
    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.
    MetadataCaching GetPropertyRulesBuilderRulesV20240212BehaviorMetadataCaching
    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.
    MobileSdkPerformance GetPropertyRulesBuilderRulesV20240212BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ModifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    ModifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    ModifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    ModifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    ModifyViaHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240212BehaviorOrigin
    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.
    OriginCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristics
    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.
    OriginCharacteristicsWsd GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    OriginFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    OriginFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    OriginIpAcl GetPropertyRulesBuilderRulesV20240212BehaviorOriginIpAcl
    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.
    PermissionsPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    PersistentClientConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    PersistentConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    PersonallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240212BehaviorPersonallyIdentifiableInformation
    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.
    PhasedRelease GetPropertyRulesBuilderRulesV20240212BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    Preconnect GetPropertyRulesBuilderRulesV20240212BehaviorPreconnect
    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.
    PredictiveContentDelivery GetPropertyRulesBuilderRulesV20240212BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    PredictivePrefetching GetPropertyRulesBuilderRulesV20240212BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    PrefreshCache GetPropertyRulesBuilderRulesV20240212BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240212BehaviorQuality
    This behavior can be used in includes.
    QuicBeta GetPropertyRulesBuilderRulesV20240212BehaviorQuicBeta
    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.
    RandomSeek GetPropertyRulesBuilderRulesV20240212BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    Rapid GetPropertyRulesBuilderRulesV20240212BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    ReadTimeout GetPropertyRulesBuilderRulesV20240212BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    RealTimeReporting GetPropertyRulesBuilderRulesV20240212BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    RealUserMonitoring GetPropertyRulesBuilderRulesV20240212BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    Redirect GetPropertyRulesBuilderRulesV20240212BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    Redirectplus GetPropertyRulesBuilderRulesV20240212BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    RefererChecking GetPropertyRulesBuilderRulesV20240212BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    RemoveQueryParameter GetPropertyRulesBuilderRulesV20240212BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    RemoveVary GetPropertyRulesBuilderRulesV20240212BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    Report GetPropertyRulesBuilderRulesV20240212BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    RequestClientHints GetPropertyRulesBuilderRulesV20240212BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    RequestControl GetPropertyRulesBuilderRulesV20240212BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    RequestTypeMarker GetPropertyRulesBuilderRulesV20240212BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    ResourceOptimizer GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    ResourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizerExtendedCompatibility
    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.
    ResponseCode GetPropertyRulesBuilderRulesV20240212BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    ResponseCookie GetPropertyRulesBuilderRulesV20240212BehaviorResponseCookie
    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.
    RestrictObjectCaching GetPropertyRulesBuilderRulesV20240212BehaviorRestrictObjectCaching
    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.
    ReturnCacheStatus GetPropertyRulesBuilderRulesV20240212BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    RewriteUrl GetPropertyRulesBuilderRulesV20240212BehaviorRewriteUrl
    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.
    RumCustom GetPropertyRulesBuilderRulesV20240212BehaviorRumCustom
    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.
    SaasDefinitions GetPropertyRulesBuilderRulesV20240212BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    SalesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudClient
    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.
    SalesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SalesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    SavePostDcaProcessing GetPropertyRulesBuilderRulesV20240212BehaviorSavePostDcaProcessing
    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.
    ScheduleInvalidation GetPropertyRulesBuilderRulesV20240212BehaviorScheduleInvalidation
    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.
    ScriptManagement GetPropertyRulesBuilderRulesV20240212BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    SegmentedContentProtection GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    SegmentedMediaOptimization GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    SegmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaStreamingPrefetch
    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.
    SetVariable GetPropertyRulesBuilderRulesV20240212BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    SimulateErrorCode GetPropertyRulesBuilderRulesV20240212BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    SiteShield GetPropertyRulesBuilderRulesV20240212BehaviorSiteShield
    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.
    StandardTlsMigration GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    StandardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigrationOverride
    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.
    StrictHeaderParsing GetPropertyRulesBuilderRulesV20240212BehaviorStrictHeaderParsing
    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.
    SubCustomer GetPropertyRulesBuilderRulesV20240212BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    SureRoute GetPropertyRulesBuilderRulesV20240212BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    TcpOptimization GetPropertyRulesBuilderRulesV20240212BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    TeaLeaf GetPropertyRulesBuilderRulesV20240212BehaviorTeaLeaf
    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.
    TieredDistribution GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistribution
    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 the cache 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.
    TieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    TieredDistributionCustomization GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    Timeout GetPropertyRulesBuilderRulesV20240212BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    UidConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorUidConfiguration
    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.
    ValidateEntityTag GetPropertyRulesBuilderRulesV20240212BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    VerifyJsonWebToken GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    VerifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    VerifyTokenAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    VirtualWaitingRoom GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    VirtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    VisitorPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    VisitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    Watermarking GetPropertyRulesBuilderRulesV20240212BehaviorWatermarking
    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.
    WebApplicationFirewall GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewall
    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.
    WebSockets GetPropertyRulesBuilderRulesV20240212BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    Webdav GetPropertyRulesBuilderRulesV20240212BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240212BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20240212BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20240212BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240212BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20240212BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20240212BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20240212BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20240212BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20240212BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20240212BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20240212BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20240212BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20240212BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20240212BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20240212BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20240212BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20240212BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20240212BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20240212BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20240212BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20240212BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20240212BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20240212BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20240212BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240212BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20240212BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20240212BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20240212BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20240212BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20240212BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20240212BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20240212BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20240212BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20240212BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20240212BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20240212BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20240212BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20240212BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240212BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20240212BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20240212BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20240212BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20240212BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20240212BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20240212BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20240212BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20240212BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20240212BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20240212BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20240212BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20240212BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20240212BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20240212BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20240212BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240212BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20240212BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20240212BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20240212BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20240212BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20240212BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20240212BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20240212BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20240212BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20240212BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240212BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240212BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20240212BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20240212BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20240212BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20240212BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20240212BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20240212BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20240212BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20240212BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20240212BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20240212BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240212BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20240212BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240212BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20240212BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20240212BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20240212BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240212BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20240212BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240212BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20240212BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20240212BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20240212BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20240212BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20240212BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240212BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20240212BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20240212BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20240212BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20240212BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20240212BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20240212BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20240212BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20240212BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20240212BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20240212BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20240212BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20240212BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20240212BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20240212BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20240212BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20240212BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20240212BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20240212BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20240212BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20240212BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20240212BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20240212BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20240212BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20240212BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20240212BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20240212BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20240212BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20240212BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20240212BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20240212BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20240212BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20240212BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20240212BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20240212BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20240212BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20240212BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20240212BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20240212BehaviorWebdav
    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.
    adScalerCircuitBreaker GetPropertyRulesBuilderRulesV20240212BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20240212BehaviorAdvanced
    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.
    aggregatedReporting GetPropertyRulesBuilderRulesV20240212BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizerTag
    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.
    allHttpInCacheHierarchy GetPropertyRulesBuilderRulesV20240212BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins GetPropertyRulesBuilderRulesV20240212BehaviorAllowCloudletsOrigins
    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.
    allowDelete GetPropertyRulesBuilderRulesV20240212BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsDowngrade
    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.
    allowOptions GetPropertyRulesBuilderRulesV20240212BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch GetPropertyRulesBuilderRulesV20240212BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPost GetPropertyRulesBuilderRulesV20240212BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allowPut GetPropertyRulesBuilderRulesV20240212BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding GetPropertyRulesBuilderRulesV20240212BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader GetPropertyRulesBuilderRulesV20240212BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancer
    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.
    audienceSegmentation GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentation
    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.
    autoDomainValidation GetPropertyRulesBuilderRulesV20240212BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory GetPropertyRulesBuilderRulesV20240212BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing GetPropertyRulesBuilderRulesV20240212BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20240212BehaviorBreadcrumbs
    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.
    breakConnection GetPropertyRulesBuilderRulesV20240212BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20240212BehaviorBrotli
    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.
    cacheError GetPropertyRulesBuilderRulesV20240212BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cacheId GetPropertyRulesBuilderRulesV20240212BehaviorCacheId
    Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
    cacheKeyIgnoreCase GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyQueryParams
    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.
    cacheKeyRewrite GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyRewrite
    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.
    cachePost GetPropertyRulesBuilderRulesV20240212BehaviorCachePost
    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.
    cacheRedirect GetPropertyRulesBuilderRulesV20240212BehaviorCacheRedirect
    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.
    cacheTag GetPropertyRulesBuilderRulesV20240212BehaviorCacheTag
    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. The cacheTag 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.
    cacheTagVisible GetPropertyRulesBuilderRulesV20240212BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240212BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects GetPropertyRulesBuilderRulesV20240212BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth GetPropertyRulesBuilderRulesV20240212BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorClientCharacteristics
    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.
    cloudInterconnects GetPropertyRulesBuilderRulesV20240212BehaviorCloudInterconnects
    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.
    cloudWrapper GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapperAdvanced
    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.
    commonMediaClientData GetPropertyRulesBuilderRulesV20240212BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin GetPropertyRulesBuilderRulesV20240212BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    constructResponse GetPropertyRulesBuilderRulesV20240212BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristics
    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.
    contentCharacteristicsAmd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsAmd
    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.
    contentCharacteristicsDd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsDd
    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.
    contentCharacteristicsWsdLargeFile GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLargeFile
    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.
    contentCharacteristicsWsdLive GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLive
    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.
    contentCharacteristicsWsdVod GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdVod
    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.
    contentPrePosition GetPropertyRulesBuilderRulesV20240212BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection GetPropertyRulesBuilderRulesV20240212BehaviorContentTargetingProtection
    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.
    corsSupport GetPropertyRulesBuilderRulesV20240212BehaviorCorsSupport
    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.
    cpCode GetPropertyRulesBuilderRulesV20240212BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    customBehavior GetPropertyRulesBuilderRulesV20240212BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20240212BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20240212BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthVariableExtractor
    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.
    dcpDefaultAuthzGroups GetPropertyRulesBuilderRulesV20240212BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations GetPropertyRulesBuilderRulesV20240212BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth GetPropertyRulesBuilderRulesV20240212BehaviorDcpRealTimeAuth
    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.
    deliveryReceipt GetPropertyRulesBuilderRulesV20240212BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyAccess
    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.
    denyDirectFailoverAccess GetPropertyRulesBuilderRulesV20240212BehaviorDenyDirectFailoverAccess
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicCacheId
    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.
    deviceCharacteristicHeader GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsPrefresh
    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.
    downgradeProtocol GetPropertyRulesBuilderRulesV20240212BehaviorDowngradeProtocol
    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.
    downloadCompleteMarker GetPropertyRulesBuilderRulesV20240212BehaviorDownloadCompleteMarker
    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.
    downloadNotification GetPropertyRulesBuilderRulesV20240212BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache GetPropertyRulesBuilderRulesV20240212BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimization
    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.
    dynamicThroughtputOptimizationOverride GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimizationOverride
    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.
    dynamicWebContent GetPropertyRulesBuilderRulesV20240212BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload GetPropertyRulesBuilderRulesV20240212BehaviorEcmsBulkUpload
    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.
    ecmsDatabase GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDataset
    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.
    ecmsObjectKey GetPropertyRulesBuilderRulesV20240212BehaviorEcmsObjectKey
    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.
    edgeConnect GetPropertyRulesBuilderRulesV20240212BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingAdvanced
    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.
    edgeLoadBalancingDataCenter GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenter
    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.
    edgeLoadBalancingOrigin GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingOrigin
    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.
    edgeOriginAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorEdgeOriginAuthorization
    Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
    edgeRedirector GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape GetPropertyRulesBuilderRulesV20240212BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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.
    edgeSideIncludes GetPropertyRulesBuilderRulesV20240212BehaviorEdgeSideIncludes
    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, or filename. 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.
    edgeWorker GetPropertyRulesBuilderRulesV20240212BehaviorEdgeWorker
    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.
    enforceMtlsSettings GetPropertyRulesBuilderRulesV20240212BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedAkamaiProtocol
    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.
    enhancedProxyDetection GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedProxyDetection
    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.
    epdForwardHeaderEnrichment GetPropertyRulesBuilderRulesV20240212BehaviorEpdForwardHeaderEnrichment
    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.
    failAction GetPropertyRulesBuilderRulesV20240212BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorFailoverBotManagerFeatureCompatibility
    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.
    fastInvalidate GetPropertyRulesBuilderRulesV20240212BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20240212BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20240212BehaviorG2oheader
    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.
    globalRequestNumber GetPropertyRulesBuilderRulesV20240212BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching GetPropertyRulesBuilderRulesV20240212BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse GetPropertyRulesBuilderRulesV20240212BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorHdDataAdvanced
    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.
    healthDetection GetPropertyRulesBuilderRulesV20240212BehaviorHealthDetection
    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.
    hsafEipBinding GetPropertyRulesBuilderRulesV20240212BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity GetPropertyRulesBuilderRulesV20240212BehaviorHttpStrictTransportSecurity
    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.
    httpToHttpsUpgrade GetPropertyRulesBuilderRulesV20240212BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride GetPropertyRulesBuilderRulesV20240212BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManager
    This behavior can be used in includes.
    imageManager GetPropertyRulesBuilderRulesV20240212BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20240212BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20240212BehaviorInstant
    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.
    instantConfig GetPropertyRulesBuilderRulesV20240212BehaviorInstantConfig
    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.
    largeFileOptimization GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom GetPropertyRulesBuilderRulesV20240212BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse GetPropertyRulesBuilderRulesV20240212BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization GetPropertyRulesBuilderRulesV20240212BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting GetPropertyRulesBuilderRulesV20240212BehaviorManifestRerouting
    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.
    manualServerPush GetPropertyRulesBuilderRulesV20240212BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration GetPropertyRulesBuilderRulesV20240212BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout GetPropertyRulesBuilderRulesV20240212BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient GetPropertyRulesBuilderRulesV20240212BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization GetPropertyRulesBuilderRulesV20240212BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover GetPropertyRulesBuilderRulesV20240212BehaviorMediaOriginFailover
    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.
    metadataCaching GetPropertyRulesBuilderRulesV20240212BehaviorMetadataCaching
    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.
    mobileSdkPerformance GetPropertyRulesBuilderRulesV20240212BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader GetPropertyRulesBuilderRulesV20240212BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240212BehaviorOrigin
    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.
    originCharacteristics GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristics
    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.
    originCharacteristicsWsd GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl GetPropertyRulesBuilderRulesV20240212BehaviorOriginIpAcl
    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.
    permissionsPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation GetPropertyRulesBuilderRulesV20240212BehaviorPersonallyIdentifiableInformation
    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.
    phasedRelease GetPropertyRulesBuilderRulesV20240212BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20240212BehaviorPreconnect
    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.
    predictiveContentDelivery GetPropertyRulesBuilderRulesV20240212BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching GetPropertyRulesBuilderRulesV20240212BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache GetPropertyRulesBuilderRulesV20240212BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240212BehaviorQuality
    This behavior can be used in includes.
    quicBeta GetPropertyRulesBuilderRulesV20240212BehaviorQuicBeta
    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.
    randomSeek GetPropertyRulesBuilderRulesV20240212BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20240212BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout GetPropertyRulesBuilderRulesV20240212BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting GetPropertyRulesBuilderRulesV20240212BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring GetPropertyRulesBuilderRulesV20240212BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20240212BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20240212BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking GetPropertyRulesBuilderRulesV20240212BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter GetPropertyRulesBuilderRulesV20240212BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary GetPropertyRulesBuilderRulesV20240212BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20240212BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    requestClientHints GetPropertyRulesBuilderRulesV20240212BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl GetPropertyRulesBuilderRulesV20240212BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker GetPropertyRulesBuilderRulesV20240212BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizerExtendedCompatibility
    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.
    responseCode GetPropertyRulesBuilderRulesV20240212BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie GetPropertyRulesBuilderRulesV20240212BehaviorResponseCookie
    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.
    restrictObjectCaching GetPropertyRulesBuilderRulesV20240212BehaviorRestrictObjectCaching
    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.
    returnCacheStatus GetPropertyRulesBuilderRulesV20240212BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl GetPropertyRulesBuilderRulesV20240212BehaviorRewriteUrl
    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.
    rumCustom GetPropertyRulesBuilderRulesV20240212BehaviorRumCustom
    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.
    saasDefinitions GetPropertyRulesBuilderRulesV20240212BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudClient
    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.
    salesForceCommerceCloudProvider GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing GetPropertyRulesBuilderRulesV20240212BehaviorSavePostDcaProcessing
    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.
    scheduleInvalidation GetPropertyRulesBuilderRulesV20240212BehaviorScheduleInvalidation
    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.
    scriptManagement GetPropertyRulesBuilderRulesV20240212BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaStreamingPrefetch
    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.
    setVariable GetPropertyRulesBuilderRulesV20240212BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode GetPropertyRulesBuilderRulesV20240212BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield GetPropertyRulesBuilderRulesV20240212BehaviorSiteShield
    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.
    standardTlsMigration GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigrationOverride
    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.
    strictHeaderParsing GetPropertyRulesBuilderRulesV20240212BehaviorStrictHeaderParsing
    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.
    subCustomer GetPropertyRulesBuilderRulesV20240212BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute GetPropertyRulesBuilderRulesV20240212BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization GetPropertyRulesBuilderRulesV20240212BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf GetPropertyRulesBuilderRulesV20240212BehaviorTeaLeaf
    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.
    tieredDistribution GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistribution
    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 the cache 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.
    tieredDistributionAdvanced GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20240212BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uidConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorUidConfiguration
    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.
    validateEntityTag GetPropertyRulesBuilderRulesV20240212BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization GetPropertyRulesBuilderRulesV20240212BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoomWithEdgeWorkers
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20240212BehaviorWatermarking
    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.
    webApplicationFirewall GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewall
    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.
    webSockets GetPropertyRulesBuilderRulesV20240212BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20240212BehaviorWebdav
    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_circuit_breaker GetPropertyRulesBuilderRulesV20240212BehaviorAdScalerCircuitBreaker
    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. The adScalerCircuitBreaker 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 GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveAcceleration
    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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptive_image_compression GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveImageCompression
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. This behavior can be used in includes.
    advanced GetPropertyRulesBuilderRulesV20240212BehaviorAdvanced
    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 GetPropertyRulesBuilderRulesV20240212BehaviorAggregatedReporting
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes.
    akamaizer GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizer
    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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizer_tag GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizerTag
    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_in_cache_hierarchy GetPropertyRulesBuilderRulesV20240212BehaviorAllHttpInCacheHierarchy
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allow_cloudlets_origins GetPropertyRulesBuilderRulesV20240212BehaviorAllowCloudletsOrigins
    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 GetPropertyRulesBuilderRulesV20240212BehaviorAllowDelete
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_https_cache_key_sharing GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsCacheKeySharing
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allow_https_downgrade GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsDowngrade
    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 GetPropertyRulesBuilderRulesV20240212BehaviorAllowOptions
    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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allow_patch GetPropertyRulesBuilderRulesV20240212BehaviorAllowPatch
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_post GetPropertyRulesBuilderRulesV20240212BehaviorAllowPost
    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, and allowPut behaviors. This behavior can be used in includes.
    allow_put GetPropertyRulesBuilderRulesV20240212BehaviorAllowPut
    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, and allowPost behaviors. This behavior can be used in includes.
    allow_transfer_encoding GetPropertyRulesBuilderRulesV20240212BehaviorAllowTransferEncoding
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    alt_svc_header GetPropertyRulesBuilderRulesV20240212BehaviorAltSvcHeader
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    api_prioritization GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritization
    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 the visitorPrioritization behavior. This behavior can be used in includes.
    application_load_balancer GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancer
    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 GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentation
    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_validation GetPropertyRulesBuilderRulesV20240212BehaviorAutoDomainValidation
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    base_directory GetPropertyRulesBuilderRulesV20240212BehaviorBaseDirectory
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    boss_beaconing GetPropertyRulesBuilderRulesV20240212BehaviorBossBeaconing
    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.
    breadcrumbs GetPropertyRulesBuilderRulesV20240212BehaviorBreadcrumbs
    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 GetPropertyRulesBuilderRulesV20240212BehaviorBreakConnection
    This behavior simulates an origin connection problem, typically to test an accompanying failAction policy. This behavior can be used in includes.
    brotli GetPropertyRulesBuilderRulesV20240212BehaviorBrotli
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCacheError
    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, and 505. This behavior can be used in includes.
    cache_id GetPropertyRulesBuilderRulesV20240212BehaviorCacheId
    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_ignore_case GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyIgnoreCase
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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_query_params GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyQueryParams
    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_rewrite GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyRewrite
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCachePost
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCacheRedirect
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCacheTag
    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. The cacheTag 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_visible GetPropertyRulesBuilderRulesV20240212BehaviorCacheTagVisible
    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 the modifyOutgoingResponseHeader 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 GetPropertyRulesBuilderRulesV20240212BehaviorCaching
    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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    central_authorization GetPropertyRulesBuilderRulesV20240212BehaviorCentralAuthorization
    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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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 GetPropertyRulesBuilderRulesV20240212BehaviorChaseRedirects
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    client_certificate_auth GetPropertyRulesBuilderRulesV20240212BehaviorClientCertificateAuth
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    client_characteristics GetPropertyRulesBuilderRulesV20240212BehaviorClientCharacteristics
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCloudInterconnects
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapper
    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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloud_wrapper_advanced GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapperAdvanced
    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.
    common_media_client_data GetPropertyRulesBuilderRulesV20240212BehaviorCommonMediaClientData
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditional_origin GetPropertyRulesBuilderRulesV20240212BehaviorConditionalOrigin
    This behavior cannot be used in includes.
    construct_response GetPropertyRulesBuilderRulesV20240212BehaviorConstructResponse
    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, and allowDelete behaviors. This behavior can be used in includes.
    content_characteristics GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristics
    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_amd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsAmd
    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_dd GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsDd
    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_wsd_large_file GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLargeFile
    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_wsd_live GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLive
    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_wsd_vod GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdVod
    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_position GetPropertyRulesBuilderRulesV20240212BehaviorContentPrePosition
    Content Preposition. This behavior can be used in includes.
    content_targeting_protection GetPropertyRulesBuilderRulesV20240212BehaviorContentTargetingProtection
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCorsSupport
    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 GetPropertyRulesBuilderRulesV20240212BehaviorCpCode
    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 the List CP codes operation. This behavior can be used in includes.
    custom_behavior GetPropertyRulesBuilderRulesV20240212BehaviorCustomBehavior
    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 relevant behaviorId value from the response within the current customBehavior. See Custom behaviors and overrides for guidance on custom metadata behaviors. This behavior can be used in includes.
    datastream GetPropertyRulesBuilderRulesV20240212BehaviorDatastream
    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 the DataStream API to aggregate the data. This behavior cannot be used in includes.
    dcp GetPropertyRulesBuilderRulesV20240212BehaviorDcp
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcp_auth_hmac_transformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthHmacTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_regex_transformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthRegexTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_substring_transformation GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthSubstringTransformation
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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_variable_extractor GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthVariableExtractor
    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_authz_groups GetPropertyRulesBuilderRulesV20240212BehaviorDcpDefaultAuthzGroups
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcp_dev_relations GetPropertyRulesBuilderRulesV20240212BehaviorDcpDevRelations
    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 with verifyJsonWebTokenForDcp, 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_time_auth GetPropertyRulesBuilderRulesV20240212BehaviorDcpRealTimeAuth
    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 GetPropertyRulesBuilderRulesV20240212BehaviorDeliveryReceipt
    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. See Secure property requirements for guidance. This behavior can be used in includes.
    deny_access GetPropertyRulesBuilderRulesV20240212BehaviorDenyAccess
    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_failover_access GetPropertyRulesBuilderRulesV20240212BehaviorDenyDirectFailoverAccess
    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_cache_id GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicCacheId
    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_header GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicHeader
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dns_async_refresh GetPropertyRulesBuilderRulesV20240212BehaviorDnsAsyncRefresh
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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 GetPropertyRulesBuilderRulesV20240212BehaviorDnsPrefresh
    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 GetPropertyRulesBuilderRulesV20240212BehaviorDowngradeProtocol
    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_marker GetPropertyRulesBuilderRulesV20240212BehaviorDownloadCompleteMarker
    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 GetPropertyRulesBuilderRulesV20240212BehaviorDownloadNotification
    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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstream_cache GetPropertyRulesBuilderRulesV20240212BehaviorDownstreamCache
    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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamic_throughtput_optimization GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimization
    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_optimization_override GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimizationOverride
    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_content GetPropertyRulesBuilderRulesV20240212BehaviorDynamicWebContent
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecms_bulk_upload GetPropertyRulesBuilderRulesV20240212BehaviorEcmsBulkUpload
    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 GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDatabase
    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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecms_dataset GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDataset
    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_key GetPropertyRulesBuilderRulesV20240212BehaviorEcmsObjectKey
    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 GetPropertyRulesBuilderRulesV20240212BehaviorEdgeConnect
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edge_load_balancing_advanced GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingAdvanced
    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_balancing_data_center GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenter
    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_balancing_origin GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingOrigin
    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.
    edge_origin_authorization GetPropertyRulesBuilderRulesV20240212BehaviorEdgeOriginAuthorization
    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 GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirector
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edge_scape GetPropertyRulesBuilderRulesV20240212BehaviorEdgeScape
    EdgeScape allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a special X-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_includes GetPropertyRulesBuilderRulesV20240212BehaviorEdgeSideIncludes
    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, or filename. 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 GetPropertyRulesBuilderRulesV20240212BehaviorEdgeWorker
    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.
    enforce_mtls_settings GetPropertyRulesBuilderRulesV20240212BehaviorEnforceMtlsSettings
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhanced_akamai_protocol GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedAkamaiProtocol
    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_detection GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedProxyDetection
    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_header_enrichment GetPropertyRulesBuilderRulesV20240212BehaviorEpdForwardHeaderEnrichment
    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 GetPropertyRulesBuilderRulesV20240212BehaviorFailAction
    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 or matchResponseCode. This behavior can be used in includes.
    failover_bot_manager_feature_compatibility GetPropertyRulesBuilderRulesV20240212BehaviorFailoverBotManagerFeatureCompatibility
    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 GetPropertyRulesBuilderRulesV20240212BehaviorFastInvalidate
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips GetPropertyRulesBuilderRulesV20240212BehaviorFips
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    first_party_marketing GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketing
    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 the firstPartyMarketingPlus 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_marketing_plus GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlus
    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 the firstPartyMarketing 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 GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewrite
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    g2oheader GetPropertyRulesBuilderRulesV20240212BehaviorG2oheader
    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_number GetPropertyRulesBuilderRulesV20240212BehaviorGlobalRequestNumber
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphql_caching GetPropertyRulesBuilderRulesV20240212BehaviorGraphqlCaching
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzip_response GetPropertyRulesBuilderRulesV20240212BehaviorGzipResponse
    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 on contentType or the content's cacheability. This behavior can be used in includes.
    hd_data_advanced GetPropertyRulesBuilderRulesV20240212BehaviorHdDataAdvanced
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHealthDetection
    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_binding GetPropertyRulesBuilderRulesV20240212BehaviorHsafEipBinding
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp2
    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 GetPropertyRulesBuilderRulesV20240212BehaviorHttp3
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    http_strict_transport_security GetPropertyRulesBuilderRulesV20240212BehaviorHttpStrictTransportSecurity
    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_https_upgrade GetPropertyRulesBuilderRulesV20240212BehaviorHttpToHttpsUpgrade
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    im_override GetPropertyRulesBuilderRulesV20240212BehaviorImOverride
    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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    image_and_video_manager GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManager
    This behavior can be used in includes.
    image_manager GetPropertyRulesBuilderRulesV20240212BehaviorImageManager
    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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    image_manager_video GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideo
    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 a fileExtension. This behavior can be used in includes.
    include GetPropertyRulesBuilderRulesV20240212BehaviorInclude
    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.
    instant GetPropertyRulesBuilderRulesV20240212BehaviorInstant
    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 GetPropertyRulesBuilderRulesV20240212BehaviorInstantConfig
    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_optimization GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimization
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    large_file_optimization_advanced GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimizationAdvanced
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limit_bit_rate GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRate
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    log_custom GetPropertyRulesBuilderRulesV20240212BehaviorLogCustom
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    m_pulse GetPropertyRulesBuilderRulesV20240212BehaviorMPulse
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifest_personalization GetPropertyRulesBuilderRulesV20240212BehaviorManifestPersonalization
    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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifest_rerouting GetPropertyRulesBuilderRulesV20240212BehaviorManifestRerouting
    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_push GetPropertyRulesBuilderRulesV20240212BehaviorManualServerPush
    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 a path or filename. This behavior cannot be used in includes.
    media_acceleration GetPropertyRulesBuilderRulesV20240212BehaviorMediaAcceleration
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    media_acceleration_quic_optout GetPropertyRulesBuilderRulesV20240212BehaviorMediaAccelerationQuicOptout
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    media_client GetPropertyRulesBuilderRulesV20240212BehaviorMediaClient
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    media_file_retrieval_optimization GetPropertyRulesBuilderRulesV20240212BehaviorMediaFileRetrievalOptimization
    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 a fileExtension. This behavior can be used in includes.
    media_origin_failover GetPropertyRulesBuilderRulesV20240212BehaviorMediaOriginFailover
    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 GetPropertyRulesBuilderRulesV20240212BehaviorMetadataCaching
    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_performance GetPropertyRulesBuilderRulesV20240212BehaviorMobileSdkPerformance
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modify_incoming_request_header GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingRequestHeader
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modify_incoming_response_header GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingResponseHeader
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modify_outgoing_request_header GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingRequestHeader
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modify_outgoing_response_header GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingResponseHeader
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modify_via_header GetPropertyRulesBuilderRulesV20240212BehaviorModifyViaHeader
    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 GetPropertyRulesBuilderRulesV20240212BehaviorOrigin
    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 GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristics
    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_wsd GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristicsWsd
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    origin_failure_recovery_method GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryMethod
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    origin_failure_recovery_policy GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryPolicy
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    origin_ip_acl GetPropertyRulesBuilderRulesV20240212BehaviorOriginIpAcl
    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.
    permissions_policy GetPropertyRulesBuilderRulesV20240212BehaviorPermissionsPolicy
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistent_client_connection GetPropertyRulesBuilderRulesV20240212BehaviorPersistentClientConnection
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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 GetPropertyRulesBuilderRulesV20240212BehaviorPersistentConnection
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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_information GetPropertyRulesBuilderRulesV20240212BehaviorPersonallyIdentifiableInformation
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPhasedRelease
    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 within Control Center to set up your Cloudlets policies. This behavior cannot be used in includes.
    preconnect GetPropertyRulesBuilderRulesV20240212BehaviorPreconnect
    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_delivery GetPropertyRulesBuilderRulesV20240212BehaviorPredictiveContentDelivery
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictive_prefetching GetPropertyRulesBuilderRulesV20240212BehaviorPredictivePrefetching
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetch
    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 GetPropertyRulesBuilderRulesV20240212BehaviorPrefetchable
    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 a filename or fileExtension. This behavior can be used in includes.
    prefresh_cache GetPropertyRulesBuilderRulesV20240212BehaviorPrefreshCache
    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 GetPropertyRulesBuilderRulesV20240212BehaviorQuality
    This behavior can be used in includes.
    quic_beta GetPropertyRulesBuilderRulesV20240212BehaviorQuicBeta
    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 GetPropertyRulesBuilderRulesV20240212BehaviorRandomSeek
    Optimizes .flv and .mp4 files to allow random jump-point navigation. This behavior can be used in includes.
    rapid GetPropertyRulesBuilderRulesV20240212BehaviorRapid
    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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    read_timeout GetPropertyRulesBuilderRulesV20240212BehaviorReadTimeout
    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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    real_time_reporting GetPropertyRulesBuilderRulesV20240212BehaviorRealTimeReporting
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    real_user_monitoring GetPropertyRulesBuilderRulesV20240212BehaviorRealUserMonitoring
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    redirect GetPropertyRulesBuilderRulesV20240212BehaviorRedirect
    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 on destinationHostname and destinationPath to manipulate the hostname and path independently. This behavior can be used in includes.
    redirectplus GetPropertyRulesBuilderRulesV20240212BehaviorRedirectplus
    Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as redirect, but allows you to use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    referer_checking GetPropertyRulesBuilderRulesV20240212BehaviorRefererChecking
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    remove_query_parameter GetPropertyRulesBuilderRulesV20240212BehaviorRemoveQueryParameter
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    remove_vary GetPropertyRulesBuilderRulesV20240212BehaviorRemoveVary
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary header to make responses cacheable. This behavior can be used in includes.
    report GetPropertyRulesBuilderRulesV20240212BehaviorReport
    Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
    request_client_hints GetPropertyRulesBuilderRulesV20240212BehaviorRequestClientHints
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    request_control GetPropertyRulesBuilderRulesV20240212BehaviorRequestControl
    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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    request_type_marker GetPropertyRulesBuilderRulesV20240212BehaviorRequestTypeMarker
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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 GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizer
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resource_optimizer_extended_compatibility GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizerExtendedCompatibility
    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 GetPropertyRulesBuilderRulesV20240212BehaviorResponseCode
    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 temporary 302 redirect. This behavior can be used in includes.
    response_cookie GetPropertyRulesBuilderRulesV20240212BehaviorResponseCookie
    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_caching GetPropertyRulesBuilderRulesV20240212BehaviorRestrictObjectCaching
    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_status GetPropertyRulesBuilderRulesV20240212BehaviorReturnCacheStatus
    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 or tieredDistribution: This behavior can be used in includes.
    rewrite_url GetPropertyRulesBuilderRulesV20240212BehaviorRewriteUrl
    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 GetPropertyRulesBuilderRulesV20240212BehaviorRumCustom
    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 GetPropertyRulesBuilderRulesV20240212BehaviorSaasDefinitions
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    sales_force_commerce_cloud_client GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudClient
    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_commerce_cloud_provider GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProvider
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    sales_force_commerce_cloud_provider_host_header GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProviderHostHeader
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    save_post_dca_processing GetPropertyRulesBuilderRulesV20240212BehaviorSavePostDcaProcessing
    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 GetPropertyRulesBuilderRulesV20240212BehaviorScheduleInvalidation
    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 GetPropertyRulesBuilderRulesV20240212BehaviorScriptManagement
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmented_content_protection GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedContentProtection
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmented_media_optimization GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaOptimization
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmented_media_streaming_prefetch GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaStreamingPrefetch
    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 GetPropertyRulesBuilderRulesV20240212BehaviorSetVariable
    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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulate_error_code GetPropertyRulesBuilderRulesV20240212BehaviorSimulateErrorCode
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    site_shield GetPropertyRulesBuilderRulesV20240212BehaviorSiteShield
    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_migration GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigration
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standard_tls_migration_override GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigrationOverride
    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_parsing GetPropertyRulesBuilderRulesV20240212BehaviorStrictHeaderParsing
    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 GetPropertyRulesBuilderRulesV20240212BehaviorSubCustomer
    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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sure_route GetPropertyRulesBuilderRulesV20240212BehaviorSureRoute
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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 GetPropertyRulesBuilderRulesV20240212BehaviorTcpOptimization
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    tea_leaf GetPropertyRulesBuilderRulesV20240212BehaviorTeaLeaf
    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 GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistribution
    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 the cache 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_advanced GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionAdvanced
    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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tiered_distribution_customization GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionCustomization
    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 enable cloudWrapper within the same rule. This behavior is for internal usage only. This behavior can be used in includes.
    timeout GetPropertyRulesBuilderRulesV20240212BehaviorTimeout
    Sets the HTTP connect timeout. This behavior can be used in includes.
    uid_configuration GetPropertyRulesBuilderRulesV20240212BehaviorUidConfiguration
    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_tag GetPropertyRulesBuilderRulesV20240212BehaviorValidateEntityTag
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verify_json_web_token GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebToken
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verify_json_web_token_for_dcp GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebTokenForDcp
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verify_token_authorization GetPropertyRulesBuilderRulesV20240212BehaviorVerifyTokenAuthorization
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtual_waiting_room GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoom
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtual_waiting_room_with_edge_workers GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoomWithEdgeWorkers
    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 GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritization
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifo
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitor_prioritization_fifo_standalone GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifoStandalone
    This behavior cannot be used in includes.
    watermarking GetPropertyRulesBuilderRulesV20240212BehaviorWatermarking
    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_firewall GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewall
    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 GetPropertyRulesBuilderRulesV20240212BehaviorWebSockets
    The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
    webdav GetPropertyRulesBuilderRulesV20240212BehaviorWebdav
    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.
    adScalerCircuitBreaker Property Map
    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. The adScalerCircuitBreaker 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.
    adaptiveAcceleration 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 the Adaptive Acceleration API to report on the set of assets this feature optimizes. This behavior cannot be used in includes.
    adaptiveImageCompression Property Map
    The Adaptive Image Compression feature compresses JPEG images depending on the requesting network's performance, thus improving response time. The behavior specifies three performance tiers based on round-trip tests: 1 for excellent, 2 for good, and 3 for poor. It assigns separate performance criteria for mobile (cellular) and non-mobile networks, which the compressMobile and compressStandard options enable independently. 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.
    aggregatedReporting Property Map
    Configure a custom report that collects traffic data. The data is based on one to four variables, such as sum, average, min, and max. 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 the akamaizerTag behavior. This behavior is for internal usage only. This behavior can be used in includes.
    akamaizerTag 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.
    allHttpInCacheHierarchy Property Map
    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 the siteShield, sureRoute, and tieredDistribution behaviors.) This behavior can be used in includes.
    allowCloudletsOrigins Property Map
    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.
    allowDelete 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, and allowPut behaviors. This behavior can be used in includes.
    allowHttpsCacheKeySharing Property Map
    HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
    allowHttpsDowngrade Property Map
    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.
    allowOptions 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 the constructResponse behavior to send responses directly from the Akamai network. See also the allowDelete, allowPatch, allowPost, and allowPut behaviors. This behavior can be used in includes.
    allowPatch 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, and allowPut behaviors. This behavior can be used in includes.
    allowPost 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, and allowPut behaviors. This behavior can be used in includes.
    allowPut 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, and allowPost behaviors. This behavior can be used in includes.
    allowTransferEncoding Property Map
    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 and webdav behaviors within the same rule tree, in which case it's required. This behavior can be used in includes.
    altSvcHeader Property Map
    Sets the maximum age value for the Alternative Services (Alt-Svc) header. This behavior can be used in includes.
    apiPrioritization 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 the visitorPrioritization behavior. This behavior can be used in includes.
    applicationLoadBalancer Property Map
    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.
    audienceSegmentation 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.
    autoDomainValidation Property Map
    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 the Certificate Provisioning System API. This behavior can be used in includes.
    baseDirectory Property Map
    Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
    bossBeaconing 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.
    breadcrumbs 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.
    breakConnection 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.
    cacheError 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, and 505. This behavior can be used in includes.
    cacheId 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.
    cacheKeyIgnoreCase Property Map
    By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that File.html and file.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.
    cacheKeyQueryParams Property Map
    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.
    cacheKeyRewrite Property Map
    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.
    cachePost 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.
    cacheRedirect 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.
    cacheTag 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. The cacheTag 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.
    cacheTagVisible Property Map
    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 the modifyOutgoingResponseHeader 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 or BYPASS_CACHE HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see the Learn about caching section in the guide. This behavior can be used in includes.
    centralAuthorization 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 an If-Modified-Since header, to which the origin needs to respond with a 304 (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.
    chaseRedirects Property Map
    Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
    clientCertificateAuth Property Map
    Sends a Client-To-Edge header to your origin server with details from the mutual TLS certificate sent from the requesting client to the edge network. This establishes transitive trust between the client and your origin server. This behavior can be used in includes.
    clientCharacteristics 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.
    cloudInterconnects 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.
    cloudWrapper 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 with sureRoute or tieredDistribution. This behavior cannot be used in includes.
    cloudWrapperAdvanced Property Map
    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.
    commonMediaClientData Property Map
    Use this behavior to send expanded playback information as CMCD metadata in requests from a media player. Edge servers may use this metadata for segment prefetching to optimize your content's delivery, or for logging. For more details and additional property requirements, see the Adaptive Media Delivery documentation. This behavior can be used in includes.
    conditionalOrigin Property Map
    This behavior cannot be used in includes.
    constructResponse 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, and allowDelete behaviors. This behavior can be used in includes.
    contentCharacteristics 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.
    contentCharacteristicsAmd 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.
    contentCharacteristicsDd 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.
    contentCharacteristicsWsdLargeFile Property Map
    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.
    contentCharacteristicsWsdLive Property Map
    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.
    contentCharacteristicsWsdVod Property Map
    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.
    contentPrePosition Property Map
    Content Preposition. This behavior can be used in includes.
    contentTargetingProtection Property Map
    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.
    corsSupport 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.
    cpCode 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 the List CP codes operation. This behavior can be used in includes.
    customBehavior 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 relevant behaviorId value from the response within the current customBehavior. See Custom 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 the DataStream 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. (The IoT 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 the verifyJsonWebTokenForDcp behavior to control access. This behavior cannot be used in includes.
    dcpAuthHmacTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthRegexTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthSubstringTransformation Property Map
    The Internet of Things: Edge Connect product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction with dcpAuthVariableExtractor, 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.
    dcpAuthVariableExtractor Property Map
    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.
    dcpDefaultAuthzGroups Property Map
    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 the verifyJsonWebTokenForDcp behavior, or mutual authentication using the dcpAuthVariableExtractor behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes.
    dcpDevRelations Property Map
    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 with verifyJsonWebTokenForDcp, 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.
    dcpRealTimeAuth Property Map
    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.
    deliveryReceipt 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. See Secure property requirements for guidance. This behavior can be used in includes.
    denyAccess 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.
    denyDirectFailoverAccess Property Map
    A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
    deviceCharacteristicCacheId Property Map
    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.
    deviceCharacteristicHeader Property Map
    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 the deviceCharacteristicCacheId behavior. This behavior can be used in includes.
    dnsAsyncRefresh Property Map
    Allow an edge server to use an expired DNS record when forwarding a request to your origin. The type A DNS record refreshes after 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.
    dnsPrefresh 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.
    downgradeProtocol 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.
    downloadCompleteMarker 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 logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes.
    downloadNotification 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 the OTA Updates API for a list of completed downloads to individual vehicles. This behavior cannot be used in includes.
    downstreamCache 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 or bypass-cache, edge servers send cache-busting headers downstream to prevent downstream caching. This behavior can be used in includes.
    dynamicThroughtputOptimization Property Map
    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.
    dynamicThroughtputOptimizationOverride Property Map
    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.
    dynamicWebContent Property Map
    In conjunction with the subCustomer behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers using Akamai Cloud Embed. This behavior can be used in includes.
    ecmsBulkUpload Property Map
    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.
    ecmsDatabase 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 the ecmsDataset behavior to specify a default data set for requests. This behavior cannot be used in includes.
    ecmsDataset 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.
    ecmsObjectKey Property Map
    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.
    edgeConnect Property Map
    Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
    edgeLoadBalancingAdvanced Property Map
    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.
    edgeLoadBalancingDataCenter Property Map
    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.
    edgeLoadBalancingOrigin Property Map
    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.
    edgeOriginAuthorization 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.
    edgeRedirector Property Map
    This behavior enables the Edge Redirector Cloudlet application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control the Edge Redirector within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    edgeScape 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 special X-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.
    edgeSideIncludes Property Map
    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, or filename. 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.
    edgeWorker 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.
    enforceMtlsSettings Property Map
    This behavior repeats mTLS validation checks between a requesting client and the edge network. If the checks fail, you can deny the request or apply custom error handling. To use this behavior, you need to add either the hostname or clientCertificate criteria to the same rule. This behavior can be used in includes.
    enhancedAkamaiProtocol Property Map
    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.
    enhancedProxyDetection Property Map
    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.
    epdForwardHeaderEnrichment Property Map
    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.
    failAction 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 or matchResponseCode. This behavior can be used in includes.
    failoverBotManagerFeatureCompatibility Property Map
    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.
    fastInvalidate Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    fips Property Map
    Ensures Federal Information Process Standards (FIPS) 140-2 compliance for a connection to an origin server. For this behavior to work properly, verify that your origin's secure certificate supports Enhanced TLS and is FIPS-compliant. This behavior can be used in includes.
    firstPartyMarketing Property Map
    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 the firstPartyMarketingPlus 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.
    firstPartyMarketingPlus Property Map
    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 the firstPartyMarketing behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes.
    forwardRewrite 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 within Control Center, or use the Cloudlets API to configure it programmatically. 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.
    globalRequestNumber Property Map
    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's Translate error string operation to get low-level details about any request. This behavior can be used in includes.
    graphqlCaching Property Map
    This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allowPost to cache POST responses. To configure REST API traffic, use the rapid behavior. This behavior can be used in includes.
    gzipResponse 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 on contentType or the content's cacheability. This behavior can be used in includes.
    hdDataAdvanced Property Map
    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.
    healthDetection 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.
    hsafEipBinding Property Map
    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 the Property Manager documentation for guidance. This behavior cannot be used in includes.
    httpStrictTransportSecurity Property Map
    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.
    httpToHttpsUpgrade Property Map
    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 with originCertsToHonor to verify SSL certificates. This behavior can be used in includes.
    imOverride 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's rule tree variables to one of Image and Video Manager's own policy variables. This behavior can be used in includes.
    imageAndVideoManager Property Map
    This behavior can be used in includes.
    imageManager 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 a fileExtension. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes.
    imageManagerVideo Property Map
    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 a fileExtension. 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.
    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.
    instantConfig 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.
    largeFileOptimization Property Map
    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 the useVersioning option while enforcing your own filename versioning policy. Make sure you meet all the requirements and best practices for the LFO delivery. This behavior can be used in includes.
    largeFileOptimizationAdvanced Property Map
    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 use NetStorage for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes.
    limitBitRate Property Map
    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 a thresholdTable 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 a contentType, path, or filename. This behavior can be used in includes.
    logCustom Property Map
    Logs custom details from the origin response in the Log Delivery Service report. This behavior can be used in includes.
    mPulse Property Map
    mPulse provides high-level performance analytics and predictive recommendations based on real end user data. See the mPulse Quick Start to set up mPulse on your website. This behavior cannot be used in includes.
    manifestPersonalization 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, see Adaptive Media Delivery. This behavior can be used in includes.
    manifestRerouting 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.
    manualServerPush Property Map
    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 a path or filename. This behavior cannot be used in includes.
    mediaAcceleration Property Map
    Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
    mediaAccelerationQuicOptout Property Map
    When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
    mediaClient Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    mediaFileRetrievalOptimization Property Map
    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 a fileExtension. This behavior can be used in includes.
    mediaOriginFailover Property Map
    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.
    metadataCaching 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.
    mobileSdkPerformance Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    modifyIncomingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
    modifyIncomingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
    modifyOutgoingRequestHeader Property Map
    Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
    modifyOutgoingResponseHeader Property Map
    Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
    modifyViaHeader Property Map
    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.
    originCharacteristics 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.
    originCharacteristicsWsd Property Map
    Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
    originFailureRecoveryMethod Property Map
    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 the originFailureRecoveryPolicy member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes.
    originFailureRecoveryPolicy Property Map
    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 in Adaptive Media Delivery Implementation Guide. You can use the originFailureRecoveryMethod member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes.
    originIpAcl Property Map
    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.
    permissionsPolicy Property Map
    Manages whether your page and its embedded iframes can access various browser features that affect end-user privacy, security, and performance. This behavior can be used in includes.
    persistentClientConnection Property Map
    This behavior activates persistent connections between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with the persistentConnection 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.
    persistentConnection Property Map
    This behavior enables more efficient persistent connections from origin to edge server to client. Compare with the persistentClientConnection 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.
    personallyIdentifiableInformation Property Map
    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.
    phasedRelease 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 within Control 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.
    predictiveContentDelivery Property Map
    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 for behavior is set to LIVE. This behavior can be used in includes.
    predictivePrefetching 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 a filename or fileExtension. This behavior can be used in includes.
    prefreshCache 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.
    quicBeta 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.
    randomSeek 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's API Endpoints API to configure how the traffic responds. Use the API Keys and Traffic Management API to control access to your APIs. This behavior cannot be used in includes.
    readTimeout 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. Any failure to read aborts the request and sends a 504 Gateway Timeout error to the client. Contact Akamai Professional Services for help configuring this behavior. This behavior can be used in includes.
    realTimeReporting Property Map
    This enables Real-Time Reporting for Akamai Cloud Embed customers. The behavior can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior can be used in includes.
    realUserMonitoring Property Map
    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 on destinationHostname and destinationPath 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 use variables to express the redirect destination's component values more concisely. This behavior can be used in includes.
    refererChecking Property Map
    Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
    removeQueryParameter Property Map
    Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
    removeVary Property Map
    By default, responses that feature a Vary header value of anything other than Accept-Encoding and a corresponding Content-Encoding: gzip header aren't cached on edge servers. Vary headers indicate when a URL's content varies depending on some variable, such as which User-Agent requests it. This behavior simply removes the Vary 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.
    requestClientHints Property Map
    Client hints are HTTP request header fields that determine which resources the browser should include in the response. This behavior configures and prioritizes the client hints you want to send to request specific client and device information. This behavior can be used in includes.
    requestControl 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 within Control Center, or use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    requestTypeMarker Property Map
    The Internet of Things: OTA Updates product allows customers to securely distribute firmware to devices over cellular networks. When using the downloadCompleteMarker 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.
    resourceOptimizer Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    resourceOptimizerExtendedCompatibility Property Map
    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.
    responseCode 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 temporary 302 redirect. This behavior can be used in includes.
    responseCookie 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.
    restrictObjectCaching Property Map
    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.
    returnCacheStatus Property Map
    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 or tieredDistribution: This behavior can be used in includes.
    rewriteUrl 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.
    rumCustom 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.
    saasDefinitions Property Map
    Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_STRING, or HOSTNAME components as identifiers, or disable the SaaS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose originType option is set to SAAS_DYNAMIC_ORIGIN. This behavior cannot be used in includes.
    salesForceCommerceCloudClient Property Map
    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.
    salesForceCommerceCloudProvider Property Map
    This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    salesForceCommerceCloudProviderHostHeader Property Map
    Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
    savePostDcaProcessing Property Map
    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.
    scheduleInvalidation 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.
    scriptManagement Property Map
    Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. This behavior cannot be used in includes.
    segmentedContentProtection Property Map
    Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
    segmentedMediaOptimization Property Map
    Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
    segmentedMediaStreamingPrefetch Property Map
    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.
    setVariable 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 this valueSource, 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 a transform function to modify the value once. See Support for variables for more information. This behavior can be used in includes.
    simulateErrorCode Property Map
    This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
    siteShield 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.
    standardTlsMigration Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
    standardTlsMigrationOverride 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.
    strictHeaderParsing Property Map
    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.
    subCustomer 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 the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamicWebContent behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes.
    sureRoute Property Map
    The SureRoute feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races 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.
    tcpOptimization Property Map
    This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
    teaLeaf 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.
    tieredDistribution 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 the cache 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.
    tieredDistributionAdvanced 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 the cache 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 than tieredDistribution. This behavior is for internal usage only. This behavior can be used in includes.
    tieredDistributionCustomization Property Map
    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 enable cloudWrapper 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.
    uidConfiguration 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.
    validateEntityTag Property Map
    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 of Last-Modified and If-Modified-Since headers. This behavior can be used in includes.
    verifyJsonWebToken Property Map
    This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
    verifyJsonWebTokenForDcp Property Map
    This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing IoT Edge Connect, which you use the dcp 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 the verifyJsonWebToken behavior for other JWT validation. This behavior can be used in includes.
    verifyTokenAuthorization Property Map
    Verifies Auth 2.0 tokens. This behavior can be used in includes.
    virtualWaitingRoom Property Map
    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 within Control Center. Otherwise use the Cloudlets API to configure it programmatically. This behavior cannot be used in includes.
    virtualWaitingRoomWithEdgeWorkers Property Map
    This behavior allows you to configure the virtualWaitingRoom behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes.
    visitorPrioritization Property Map
    The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifo Property Map
    (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, choose Your services > Edge logic Cloudlets to control Visitor Prioritization (FIFO) within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the apiPrioritization behavior. This behavior cannot be used in includes.
    visitorPrioritizationFifoStandalone Property Map
    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.
    webApplicationFirewall Property Map
    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.
    webSockets 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorAdScalerCircuitBreaker

    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FallbackActionResponseCodeBased string
    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.
    ResponseCodeBased bool
    Triggers a fallback action based on the response code from the technology partner's server.
    ResponseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    ResponseDelayBased bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    ResponseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    ReturnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    SpecifyYourOwnResponseCodeBased string
    Defines a custom error response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    fallbackActionResponseCodeBased string
    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.
    responseCodeBased boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes string
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold string
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased string
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased string
    Defines a custom error response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response_code_based str
    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_based bool
    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, or SPECIFY_YOUR_OWN for a custom code.
    response_delay_based bool
    Triggers a fallback action based on the delayed response from the technology partner's server.
    response_delay_threshold str
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    return_error_response_code_based str
    Specifies the error to include in the response to the client.
    specify_your_own_response_code_based str
    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.
    fallbackActionResponseCodeBased String
    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.
    responseCodeBased Boolean
    Triggers a fallback action based on the response code from the technology partner's server.
    responseCodes String
    Specifies the codes in the partner's response that trigger the fallback action, either 408, 500, 502, 504, SAME_AS_RECEIEVED, or SPECIFY_YOUR_OWN for a custom code.
    responseDelayBased Boolean
    Triggers a fallback action based on the delayed response from the technology partner's server.
    responseDelayThreshold String
    Specifies the maximum response delay that, if exceeded, triggers the fallback action.
    returnErrorResponseCodeBased String
    Specifies the error to include in the response to the client.
    specifyYourOwnResponseCodeBased String
    Defines a custom error response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveAcceleration

    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    AbLogic 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. See Add A/B testing to A2 for details.
    AbTesting 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.
    CookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    EnableBrotliCompression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    EnableForNoncacheable bool
    Applies Brotli compression to non-cacheable content.
    EnablePreconnect bool
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    EnablePush 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.
    EnableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    PreloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    TemplateUuid string
    This option is for internal usage only.
    TitleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName string
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid string
    This option is for internal usage only.
    titleBrotli string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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. See Add 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.
    cookie_name str
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enable_brotli_compression bool
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enable_for_noncacheable bool
    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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring 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_server_push str
    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.
    abLogic 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. See Add A/B testing to A2 for details.
    abTesting 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.
    cookieName String
    This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
    enableBrotliCompression Boolean
    Applies Brotli compression, converting your origin content to cache on edge servers.
    enableForNoncacheable Boolean
    Applies Brotli compression to non-cacheable content.
    enablePreconnect Boolean
    Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See Automatic Preconnect for more information.
    enablePush 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.
    enableRo 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 the resourceOptimizer and resourceOptimizerExtendedCompatibility 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.
    preloadEnable 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 or realUserMonitoring. The recommended mPulse option supports all optimizations and requires the mPulse behavior added by default to new Ion properties. The classic realUserMonitoring method has been deprecated. If you set it as the data source, make sure you use it with the realUserMonitoring behavior.
    templateUuid String
    This option is for internal usage only.
    titleBrotli String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleHttp2ServerPush String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreconnect String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titlePreload String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleRo 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorAdaptiveImageCompression

    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    CompressMobile bool
    Adapts images served over cellular mobile networks.
    CompressStandard 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.
    TemplateUuid string
    This option is for internal usage only.
    Tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    Tier1MobileCompressionValue int
    Specifies the compression percentage.
    Tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    Tier1StandardCompressionValue int
    Specifies the compression percentage.
    Tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    Tier2MobileCompressionValue int
    Specifies the compression percentage.
    Tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    Tier2StandardCompressionValue int
    Specifies the compression percentage.
    Tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    Tier3MobileCompressionValue int
    Specifies the compression percentage.
    Tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    Tier3StandardCompressionValue int
    Specifies the compression percentage.
    TitleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TitleAicNonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Integer
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Integer
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Integer
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Integer
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Integer
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Integer
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    compressMobile boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid string
    This option is for internal usage only.
    tier1MobileCompressionMethod string
    Specifies tier-1 behavior.
    tier1MobileCompressionValue number
    Specifies the compression percentage.
    tier1StandardCompressionMethod string
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue number
    Specifies the compression percentage.
    tier2MobileCompressionMethod string
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue number
    Specifies the compression percentage.
    tier2StandardCompressionMethod string
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue number
    Specifies the compression percentage.
    tier3MobileCompressionMethod string
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue number
    Specifies the compression percentage.
    tier3StandardCompressionMethod string
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue number
    Specifies the compression percentage.
    titleAicMobile string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.
    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_compression_method str
    Specifies tier-1 behavior.
    tier1_mobile_compression_value int
    Specifies the compression percentage.
    tier1_standard_compression_method str
    Specifies tier-1 non-cellular network behavior.
    tier1_standard_compression_value int
    Specifies the compression percentage.
    tier2_mobile_compression_method str
    Specifies tier-2 cellular-network behavior.
    tier2_mobile_compression_value int
    Specifies the compression percentage.
    tier2_standard_compression_method str
    Specifies tier-2 non-cellular network behavior.
    tier2_standard_compression_value int
    Specifies the compression percentage.
    tier3_mobile_compression_method str
    Specifies tier-3 cellular-network behavior.
    tier3_mobile_compression_value int
    Specifies the compression percentage.
    tier3_standard_compression_method str
    Specifies tier-3 non-cellular network behavior.
    tier3_standard_compression_value int
    Specifies the compression percentage.
    title_aic_mobile str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    title_aic_nonmobile 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.
    compressMobile Boolean
    Adapts images served over cellular mobile networks.
    compressStandard 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.
    templateUuid String
    This option is for internal usage only.
    tier1MobileCompressionMethod String
    Specifies tier-1 behavior.
    tier1MobileCompressionValue Number
    Specifies the compression percentage.
    tier1StandardCompressionMethod String
    Specifies tier-1 non-cellular network behavior.
    tier1StandardCompressionValue Number
    Specifies the compression percentage.
    tier2MobileCompressionMethod String
    Specifies tier-2 cellular-network behavior.
    tier2MobileCompressionValue Number
    Specifies the compression percentage.
    tier2StandardCompressionMethod String
    Specifies tier-2 non-cellular network behavior.
    tier2StandardCompressionValue Number
    Specifies the compression percentage.
    tier3MobileCompressionMethod String
    Specifies tier-3 cellular-network behavior.
    tier3MobileCompressionValue Number
    Specifies the compression percentage.
    tier3StandardCompressionMethod String
    Specifies tier-3 non-cellular network behavior.
    tier3StandardCompressionValue Number
    Specifies the compression percentage.
    titleAicMobile String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    titleAicNonmobile 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorAggregatedReporting

    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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    AttributesCount 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.
    ReportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName string
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    attributesCount 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.
    reportName String
    The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizer

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAkamaizerTag

    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    IncludeTagsAttribute 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.
    MatchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    ReplaceAll bool
    Replaces all matches when enabled, otherwise replaces only the first match.
    ReplacementHostname string
    Specifies the replacement hostname for the tag to use.
    Scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    TagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    includeTagsAttribute 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.
    matchHostname string
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname string
    Specifies the replacement hostname for the tag to use.
    scope string
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute string
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    include_tags_attribute 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.
    tags_attribute 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.
    includeTagsAttribute 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.
    matchHostname String
    Specifies the hostname to match on as a Perl-compatible regular expression.
    replaceAll Boolean
    Replaces all matches when enabled, otherwise replaces only the first match.
    replacementHostname String
    Specifies the replacement hostname for the tag to use.
    scope String
    Specifies the part of HTML content the tagsAttribute refers to.
    tagsAttribute String
    Specifies the tag or tag/attribute combination to operate on.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllHttpInCacheHierarchy

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowCloudletsOrigins

    Enabled bool
    Allows you to assign custom origin definitions referenced in sub-rules by cloudletsOrigin labels. If disabled, all sub-rules are ignored.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HonorBaseDirectory bool
    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.
    PurgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    honorBaseDirectory boolean
    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.
    purgeOriginQueryParameter string
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_directory bool
    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_query_parameter str
    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.
    honorBaseDirectory Boolean
    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.
    purgeOriginQueryParameter String
    When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Content Control Utility API.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowDelete

    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowBody 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowBody 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    allowBody 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsCacheKeySharing

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowHttpsDowngrade

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowOptions

    Enabled bool
    Set this to true to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to false 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 to false 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowPatch

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowPost

    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowWithoutContentLength bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    Enabled 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowWithoutContentLength boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled boolean
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_content_length bool
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled 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.
    allowWithoutContentLength Boolean
    By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.
    enabled Boolean
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowPut

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAllowTransferEncoding

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAltSvcHeader

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaxAge int
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge Integer
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maxAge number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the Alt-Svc header. The default max-age for an Alt-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.
    maxAge Number
    Specifies the max-age value in seconds for the Alt-Svc header. The default max-age for an Alt-Svc header is 93600 seconds (26 hours).
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritization

    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    AlternateResponseCacheTtl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Activates the API Prioritization feature.
    IsSharedPolicy 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.
    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.
    NetStorage GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    NetStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    TemplateUuid string
    This option is for internal usage only.
    ThrottledCpCode GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    ThrottledStatusCode int
    Specifies the HTTP response code for requests that receive the alternate response.
    UseThrottledCpCode bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    UseThrottledStatusCode bool
    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.
    alternateResponseCacheTtl Integer
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Integer
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.
    alternateResponseCacheTtl number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath string
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid string
    This option is for internal usage only.
    throttledCpCode GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode boolean
    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_cache_ttl int
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled bool
    Activates the API Prioritization feature.
    is_shared_policy 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.
    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 GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationNetStorage
    Specify the NetStorage domain that contains the alternate response.
    net_storage_path str
    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_code GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCode
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttled_status_code int
    Specifies the HTTP response code for requests that receive the alternate response.
    use_throttled_cp_code bool
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    use_throttled_status_code bool
    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.
    alternateResponseCacheTtl Number
    Specifies the alternate response's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Activates the API Prioritization feature.
    isSharedPolicy 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.
    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.
    netStorage Property Map
    Specify the NetStorage domain that contains the alternate response.
    netStoragePath String
    Specify the full NetStorage path for the alternate response, including trailing file name.
    templateUuid String
    This option is for internal usage only.
    throttledCpCode Property Map
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    throttledStatusCode Number
    Specifies the HTTP response code for requests that receive the alternate response.
    useThrottledCpCode Boolean
    Specifies whether to apply an alternative CP code for requests served the alternate response.
    useThrottledStatusCode Boolean
    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.

    GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancer

    AllDownNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps List<GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes List<string>
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllDownNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    AllDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    AllDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    AllDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowCachePrefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    CachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Activates the Application Load Balancer Cloudlet.
    FailoverAttemptsThreshold int
    Sets the number of failed requests that would trigger the failover process.
    FailoverMode string
    Determines what to do if an origin fails.
    FailoverOriginMaps []GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerFailoverOriginMap
    Specifies a fixed set of failover mapping rules.
    FailoverStatusCodes []string
    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.
    FailoverTitle 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.
    OriginCookieName string
    Specifies the name for your session cookie.
    SpecifyStickinessCookieDomain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    StickinessCookieAutomaticSalt 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.
    StickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    StickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    StickinessCookieSetHttpOnlyFlag bool
    Ensures the cookie is transmitted only over HTTP.
    StickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    StickinessDuration string
    Sets how long it is before the cookie expires.
    StickinessExpirationDate string
    Specifies when the cookie expires.
    StickinessRefresh 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.
    StickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Integer
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerFailoverOriginMap>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allDownNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile string
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode string
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode string
    Determines what to do if an origin fails.
    failoverOriginMaps GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerFailoverOriginMap[]
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes string[]
    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.
    failoverTitle 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.
    originCookieName string
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain string
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt string
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType string
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration string
    Sets how long it is before the cookie expires.
    stickinessExpirationDate string
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_net_storage GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerAllDownNetStorage
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    all_down_net_storage_file str
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    all_down_status_code str
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    all_down_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allow_cache_prefresh bool
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cached_content_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Activates the Application Load Balancer Cloudlet.
    failover_attempts_threshold int
    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_maps Sequence[GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerFailoverOriginMap]
    Specifies a fixed set of failover mapping rules.
    failover_status_codes Sequence[str]
    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.
    origin_cookie_name str
    Specifies the name for your session cookie.
    specify_stickiness_cookie_domain bool
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickiness_cookie_automatic_salt 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.
    stickiness_cookie_domain str
    Specifies the domain to track the stickiness cookie.
    stickiness_cookie_salt str
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickiness_cookie_set_http_only_flag bool
    Ensures the cookie is transmitted only over HTTP.
    stickiness_cookie_type 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_date str
    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.
    allDownNetStorage Property Map
    Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
    allDownNetStorageFile String
    Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
    allDownStatusCode String
    Specifies the HTTP response code when all load-balancing origins are unavailable.
    allDownTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowCachePrefresh Boolean
    Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
    cachedContentTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Activates the Application Load Balancer Cloudlet.
    failoverAttemptsThreshold Number
    Sets the number of failed requests that would trigger the failover process.
    failoverMode String
    Determines what to do if an origin fails.
    failoverOriginMaps List<Property Map>
    Specifies a fixed set of failover mapping rules.
    failoverStatusCodes List<String>
    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.
    failoverTitle 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.
    originCookieName String
    Specifies the name for your session cookie.
    specifyStickinessCookieDomain Boolean
    Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
    stickinessCookieAutomaticSalt Boolean
    Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.
    stickinessCookieDomain String
    Specifies the domain to track the stickiness cookie.
    stickinessCookieSalt String
    Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
    stickinessCookieSetHttpOnlyFlag Boolean
    Ensures the cookie is transmitted only over HTTP.
    stickinessCookieType String
    Determines how a cookie persistently associates the client with a load-balanced origin.
    stickinessDuration String
    Sets how long it is before the cookie expires.
    stickinessExpirationDate String
    Specifies when the cookie expires.
    stickinessRefresh 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.
    stickinessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerAllDownNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorApplicationLoadBalancerFailoverOriginMap

    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds List<string>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    FromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    ToOriginIds []string
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId string
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds string[]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    from_origin_id str
    Specifies the origin whose failure triggers the mapping rule.
    to_origin_ids Sequence[str]
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.
    fromOriginId String
    Specifies the origin whose failure triggers the mapping rule.
    toOriginIds List<String>
    Requests stuck to the fromOriginId origin retry for each alternate origin toOriginIds, until one succeeds.

    GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentation

    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    PopulationCookieAutomaticSalt 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.
    PopulationCookieDomain string
    Specifies the domain to track the population cookie.
    PopulationCookieIncludeRuleName bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    PopulationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    PopulationCookieType string
    Specifies when the segmentation cookie expires.
    PopulationDuration string
    Specifies the lifetime of the segmentation cookie.
    PopulationRefresh bool
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SegmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    SegmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    SegmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    SegmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    SegmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SpecifyPopulationCookieDomain bool
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain string
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt string
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType string
    Specifies when the segmentation cookie expires.
    populationDuration string
    Specifies the lifetime of the segmentation cookie.
    populationRefresh boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName string
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader string
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod string
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam string
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentationCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    population_cookie_automatic_salt 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.
    population_cookie_domain str
    Specifies the domain to track the population cookie.
    population_cookie_include_rule_name bool
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    population_cookie_salt str
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    population_cookie_type 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.
    segment_tracking_cookie_name str
    This cookie name specifies the name of the segmentation rule.
    segment_tracking_custom_header str
    This custom HTTP header specifies the name of the segmentation rule.
    segment_tracking_method str
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segment_tracking_query_param str
    This query parameter specifies the name of the segmentation rule.
    segment_tracking_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specify_population_cookie_domain 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    populationCookieAutomaticSalt Boolean
    Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.
    populationCookieDomain String
    Specifies the domain to track the population cookie.
    populationCookieIncludeRuleName Boolean
    When enabled, includes in the session cookie the name of the rule in which this behavior appears.
    populationCookieSalt String
    Specifies the cookie's salt value. Use this option to share the cookie across many properties.
    populationCookieType String
    Specifies when the segmentation cookie expires.
    populationDuration String
    Specifies the lifetime of the segmentation cookie.
    populationRefresh Boolean
    If disabled, sets the expiration time only if the cookie is not yet present in the request.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    segmentTrackingCookieName String
    This cookie name specifies the name of the segmentation rule.
    segmentTrackingCustomHeader String
    This custom HTTP header specifies the name of the segmentation rule.
    segmentTrackingMethod String
    Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
    segmentTrackingQueryParam String
    This query parameter specifies the name of the segmentation rule.
    segmentTrackingTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    specifyPopulationCookieDomain Boolean
    Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorAudienceSegmentationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorAutoDomainValidation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorBaseDirectory

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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/.

    GetPropertyRulesBuilderRulesV20240212BehaviorBossBeaconing

    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses List<string>
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConditionalErrorPattern string
    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.
    ConditionalHttpStatuses []string
    Specifies the set of response status codes or ranges that trigger the beacon.
    ConditionalSamplingFrequency string
    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.
    ForwardType 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.
    RequestType string
    Specify when to trigger a beacon.
    SamplingFrequency string
    Specifies a sampling frequency or disables beacons.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    conditionalErrorPattern string
    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.
    conditionalHttpStatuses string[]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency string
    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.
    forwardType 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.
    requestType string
    Specify when to trigger a beacon.
    samplingFrequency string
    Specifies a sampling frequency or disables beacons.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_pattern str
    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_statuses Sequence[str]
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditional_sampling_frequency str
    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.
    conditionalErrorPattern String
    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.
    conditionalHttpStatuses List<String>
    Specifies the set of response status codes or ranges that trigger the beacon.
    conditionalSamplingFrequency String
    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.
    forwardType 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.
    requestType String
    Specify when to trigger a beacon.
    samplingFrequency String
    Specifies a sampling frequency or disables beacons.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorBreadcrumbs

    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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    LoggingEnabled 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.
    OptMode bool
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    loggingEnabled 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.
    optMode boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 opposite ak-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.
    loggingEnabled 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.
    optMode Boolean
    Specifies whether to include Breadcrumbs data in the response header. To bypass the current optMode, append the opposite ak-bc query string to each request from your player.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorBreakConnection

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorBrotli

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheError

    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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PreserveStale bool
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preserveStale boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and 504 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 to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    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.
    preserveStale Boolean
    When enabled, the edge server preserves stale cached objects when the origin returns 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheId

    Elements List<string>
    Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    IncludeValue 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    includeValue 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    Specifies the name of the variable you want to include in the cache key.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyIgnoreCase

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyQueryParams

    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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ExactMatch 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    exactMatch 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheKeyRewrite

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    PurgeKey string
    Specifies the new cache key path as an alphanumeric value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey string
    Specifies the new cache key path as an alphanumeric value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    purgeKey String
    Specifies the new cache key path as an alphanumeric value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCachePost

    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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    TemplateUuid string
    This option is for internal usage only.
    UseBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.
    templateUuid string
    This option is for internal usage only.
    useBody 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.
    templateUuid String
    This option is for internal usage only.
    useBody 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheRedirect

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheTag

    Locked bool
    Indicates 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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: [!#$%'+./^_`|~-]
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCacheTagVisible

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCaching

    Behavior string
    Specify the caching option.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    CacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DefaultTtl string
    Set the MAX_AGE header for the cached content.
    EnhancedRfcSupport bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    ExpirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HonorMaxAge bool
    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 the max-age directive and the defaultTtl setting.
    HonorMustRevalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    HonorNoCache bool
    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 live ttl to zero seconds.
    HonorNoStore bool
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    HonorPrivate bool
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    HonorProxyRevalidate bool
    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.
    HonorSMaxage 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 the max-age directive and the defaultTtl 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.
    MustRevalidate 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.
    RevalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.
    cacheControlDirectives string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl string
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache boolean
    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 live ttl to zero seconds.
    honorNoStore boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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_directives str
    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_support bool
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-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_age bool
    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 the max-age directive and the defaultTtl setting.
    honor_must_revalidate bool
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honor_no_cache bool
    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 live ttl to zero seconds.
    honor_no_store bool
    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_revalidate bool
    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_maxage 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 the max-age directive and the defaultTtl 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 a no-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.
    cacheControlDirectives String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cacheabilitySettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    defaultTtl String
    Set the MAX_AGE header for the cached content.
    enhancedRfcSupport Boolean
    This enables honoring particular Cache-Control header directives from the origin. Supports all official RFC 7234 directives except for no-transform.
    expirationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    honorMaxAge Boolean
    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 the max-age directive and the defaultTtl setting.
    honorMustRevalidate Boolean
    This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
    honorNoCache Boolean
    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 live ttl to zero seconds.
    honorNoStore Boolean
    Instructs edge servers not to cache the response when the origin response includes the no-store directive.
    honorPrivate Boolean
    Instructs edge servers not to cache the response when the origin response includes the private directive.
    honorProxyRevalidate Boolean
    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.
    honorSMaxage 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 the max-age directive and the defaultTtl 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.
    mustRevalidate Boolean
    Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.
    revalidationSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid 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 a no-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.

    GetPropertyRulesBuilderRulesV20240212BehaviorCentralAuthorization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorChaseRedirects

    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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 HTTP 404 (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 HTTP 404 (Not Found) error instead of the last redirect.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorClientCertificateAuth

    ClientCertificateAttributes List<string>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ClientCertificateAttributes []string
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    Enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    EnableClientCertificateValidationStatus bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    EnableCompleteClientCertificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    clientCertificateAttributes string[]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    client_certificate_attributes Sequence[str]
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable bool
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enable_client_certificate_validation_status bool
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enable_complete_client_certificate bool
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked bool
    Indicates that your 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.
    clientCertificateAttributes List<String>
    Specify client certificate attributes to include in the Client-To-Edge authentication header that's sent to your origin server.
    enable Boolean
    Constructs the Client-To-Edge authentication header using information from the client to edge mTLS handshake and forwards it to your origin. You can configure your origin to acknowledge the header to enable transitive trust. Some form of the client x.509 certificate needs to be included in the header. You can include the full certificate or specific attributes.
    enableClientCertificateValidationStatus Boolean
    Whether to include the current validation status of the client certificate in the Client-To-Edge authentication header. This verifies the validation status of the certificate, regardless of the certificate attributes you're including in the header.
    enableCompleteClientCertificate Boolean
    Whether to include the complete client certificate in the header, in its binary (DER) format. DER-formatted certificates leave out the BEGIN CERTIFICATE/END CERTIFICATE statements and most often use the .der extension. Alternatively, you can specify individual clientCertificateAttributes you want included in the request.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorClientCharacteristics

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCloudInterconnects

    CloudLocations 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudLocations []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudLocations 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cloudLocations 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapper

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCloudWrapperAdvanced

    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    Enabled bool
    Enables failover for Cloud Wrapper.
    FailoverMap 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customFailoverMap string
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_map str
    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.
    customFailoverMap String
    Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
    enabled Boolean
    Enables failover for Cloud Wrapper.
    failoverMap 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCommonMediaClientData

    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableCmcdSegmentPrefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableCmcdSegmentPrefetch boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_cmcd_segment_prefetch bool
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked bool
    Indicates that your 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.
    enableCmcdSegmentPrefetch Boolean
    Uses Common Media Client Data (CMCD) metadata to determine the segment URLs your origin server prefetches to speed up content delivery.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorConditionalOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorConstructResponse

    Body string
    HTML response of up to 2000 characters to send to the end-user client.
    Enabled bool
    Serves the custom response.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ForceEviction bool
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    IgnorePurge 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.
    ResponseCode int
    The HTTP response code to send to the end-user client.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Integer
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode number
    The HTTP response code to send to the end-user client.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    forceEviction Boolean
    For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to false.
    ignorePurge 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.
    responseCode Number
    The HTTP response code to send to the end-user client.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristics

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsAmd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom double
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom double
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationDashCustom int
    Customizes the number of seconds for the segment.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHdsCustom int
    Customizes the number of seconds for the fragment.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationHlsCustom float64
    Customizes the number of seconds for the segment.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentDurationSmoothCustom float64
    Customizes the number of seconds for the fragment.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Integer
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Integer
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Double
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Double
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationDashCustom number
    Customizes the number of seconds for the segment.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom number
    Customizes the number of seconds for the fragment.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationHlsCustom number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom number
    Customizes the number of seconds for the fragment.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_dash_custom int
    Customizes the number of seconds for the segment.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hds_custom int
    Customizes the number of seconds for the fragment.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_hls_custom float
    Customizes the number of seconds for the segment.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_duration_smooth_custom float
    Customizes the number of seconds for the fragment.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationDashCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHdsCustom Number
    Customizes the number of seconds for the fragment.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationHlsCustom Number
    Customizes the number of seconds for the segment.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentDurationSmoothCustom Number
    Customizes the number of seconds for the fragment.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsDd

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    OptimizeOption bool
    Optimizes the delivery throughput and download times for large files.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    optimizeOption Boolean
    Optimizes the delivery throughput and download times for large files.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLargeFile

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    ObjectSize string
    Optimize based on the size of the object retrieved from the origin.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize string
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    objectSize String
    Optimize based on the size of the object retrieved from the origin.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdLive

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentCharacteristicsWsdVod

    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CatalogSize string
    Optimize based on the total size of the content library delivered.
    ContentType 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.
    PopularityDistribution string
    Optimize based on the content's expected popularity.
    SegmentDurationDash string
    Specifies the duration of individual segments.
    SegmentDurationHds string
    Specifies the duration of individual fragments.
    SegmentDurationHls string
    Specifies the duration of individual segments.
    SegmentDurationSmooth string
    Specifies the duration of individual fragments.
    SegmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    SegmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    Smooth bool
    Enable delivery of Smooth media.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    catalogSize string
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution string
    Optimize based on the content's expected popularity.
    segmentDurationDash string
    Specifies the duration of individual segments.
    segmentDurationHds string
    Specifies the duration of individual fragments.
    segmentDurationHls string
    Specifies the duration of individual segments.
    segmentDurationSmooth string
    Specifies the duration of individual fragments.
    segmentSizeDash string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls string
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth string
    Specifies the size of the media object retrieved from the origin.
    smooth boolean
    Enable delivery of Smooth media.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_dash str
    Specifies the duration of individual segments.
    segment_duration_hds str
    Specifies the duration of individual fragments.
    segment_duration_hls str
    Specifies the duration of individual segments.
    segment_duration_smooth str
    Specifies the duration of individual fragments.
    segment_size_dash str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hds str
    Specifies the size of the media object retrieved from the origin.
    segment_size_hls str
    Specifies the size of the media object retrieved from the origin.
    segment_size_smooth str
    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.
    catalogSize String
    Optimize based on the total size of the content library delivered.
    contentType 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.
    popularityDistribution String
    Optimize based on the content's expected popularity.
    segmentDurationDash String
    Specifies the duration of individual segments.
    segmentDurationHds String
    Specifies the duration of individual fragments.
    segmentDurationHls String
    Specifies the duration of individual segments.
    segmentDurationSmooth String
    Specifies the duration of individual fragments.
    segmentSizeDash String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHds String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeHls String
    Specifies the size of the media object retrieved from the origin.
    segmentSizeSmooth String
    Specifies the size of the media object retrieved from the origin.
    smooth Boolean
    Enable delivery of Smooth media.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentPrePosition

    Enabled bool
    Enables the Content PrePosition behavior.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FirstLocation 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.
    SecondLocation string
    SourceType string
    Targets string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation string
    sourceType string
    targets string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    firstLocation 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.
    secondLocation String
    sourceType String
    targets String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorContentTargetingProtection

    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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses List<string>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains List<string>
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    EnableGeoProtection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    EnableGeoRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableIpProtection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    EnableIpRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    EnableReferrerProtection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    EnableReferrerRedirectOnDeny bool
    When enabled, redirects denied requests rather than responding with an error code.
    Enabled bool
    Enables the Content Targeting feature.
    GeoProtectionMode string
    Specifies how to handle requests.
    GeoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    GeoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    IpAddresses []string
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    IpProtectionMode string
    Specifies how to handle requests.
    IpProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IpRedirectUrl string
    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.
    OverrideIpAddresses []string
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    ReferrerDomains []string
    Specifies the set of domains from which to allow or deny traffic.
    ReferrerProtectionMode string
    Specify the action to take.
    ReferrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ReferrerRedirectUrl string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    enableGeoProtection boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled boolean
    Enables the Content Targeting feature.
    geoProtectionMode string
    Specifies how to handle requests.
    geoProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl string
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses string[]
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode string
    Specifies how to handle requests.
    ipProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl string
    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.
    overrideIpAddresses string[]
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains string[]
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode string
    Specify the action to take.
    referrerProtectionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_protection bool
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enable_geo_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_ip_protection bool
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enable_ip_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enable_referrer_protection bool
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enable_referrer_redirect_on_deny bool
    When enabled, redirects denied requests rather than responding with an error code.
    enabled bool
    Enables the Content Targeting feature.
    geo_protection_mode str
    Specifies how to handle requests.
    geo_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geo_redirect_url str
    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_mode str
    Specifies how to handle requests.
    ip_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ip_redirect_url str
    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_addresses Sequence[str]
    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_mode str
    Specify the action to take.
    referrer_protection_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrer_redirect_url str
    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.
    enableGeoProtection Boolean
    When enabled, verifies IP addresses are unique to specific geographic regions.
    enableGeoRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableIpProtection Boolean
    Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
    enableIpRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enableReferrerProtection Boolean
    Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
    enableReferrerRedirectOnDeny Boolean
    When enabled, redirects denied requests rather than responding with an error code.
    enabled Boolean
    Enables the Content Targeting feature.
    geoProtectionMode String
    Specifies how to handle requests.
    geoProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    geoRedirectUrl String
    This specifies the full URL to the redirect page for denied requests.
    ipAddresses List<String>
    Specify a set of IP addresses or CIDR blocks to allow or deny.
    ipProtectionMode String
    Specifies how to handle requests.
    ipProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ipRedirectUrl String
    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.
    overrideIpAddresses List<String>
    Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
    referrerDomains List<String>
    Specifies the set of domains from which to allow or deny traffic.
    referrerProtectionMode String
    Specify the action to take.
    referrerProtectionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    referrerRedirectUrl String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCorsSupport

    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowCredentials bool
    Accepts requests made using credentials, like cookies or TLS client certificates.
    AllowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    AllowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    Enabled bool
    Enables CORS feature.
    ExposeHeaders []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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    PreflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowCredentials boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders string
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins string
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge string
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflight_max_age str
    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.
    allowCredentials Boolean
    Accepts requests made using credentials, like cookies or TLS client certificates.
    allowHeaders String
    In responses to preflight requests, defines which headers to allow when making the actual request.
    allowOrigins String
    In responses to preflight requests, sets which origin hostnames to accept requests from.
    enabled Boolean
    Enables CORS feature.
    exposeHeaders 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, and Pragma. 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, and PUT 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 or https. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications.
    preflightMaxAge String
    Defines the number of seconds that the browser should cache the response to a preflight request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorCustomBehavior

    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BehaviorId 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    behaviorId 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    behaviorId 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDatastream

    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames List<string>
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BeaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CollectMidgressTraffic bool
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    DatastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    Enabled 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.
    LogEnabled bool
    Enables log collection for the property by associating it with DataStream configurations.
    LogStreamNames []string
    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.
    LogStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SamplingPercentage int
    Specifies the percentage of log data you want to collect for this property.
    StreamType string
    Specify the DataStream type.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Integer
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    beaconStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds string
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled boolean
    Enables 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.
    logEnabled boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames string[]
    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.
    logStreamTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage number
    Specifies the percentage of log data you want to collect for this property.
    streamType string
    Specify the DataStream type.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collect_midgress_traffic bool
    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_names Sequence[str]
    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_title str
    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.
    beaconStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    collectMidgressTraffic Boolean
    If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
    datastreamIds String
    A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
    enabled Boolean
    Enables 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.
    logEnabled Boolean
    Enables log collection for the property by associating it with DataStream configurations.
    logStreamNames List<String>
    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.
    logStreamTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    samplingPercentage Number
    Specifies the percentage of log data you want to collect for this property.
    streamType String
    Specify the DataStream type.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcp

    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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    NamespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    TemplateUuid 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.
    namespaceId string
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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 the IoT 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.
    namespaceId String
    Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthHmacTransformation

    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HashConversionAlgorithm string
    Specifies the hash algorithm.
    HashConversionKey string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hashConversionAlgorithm string
    Specifies the hash algorithm.
    hashConversionKey string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_algorithm str
    Specifies the hash algorithm.
    hash_conversion_key str
    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.
    hashConversionAlgorithm String
    Specifies the hash algorithm.
    hashConversionKey String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthRegexTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RegexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern string
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    regexPattern String
    Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthSubstringTransformation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SubstringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    SubstringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd string
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart string
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    substringEnd String
    The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string's length, authentication may fail.
    substringStart String
    The zero-based index offset of the first character to extract. If the index is out of bound from the string's length, authentication may fail.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpAuthVariableExtractor

    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateField string
    Specifies the field in the client certificate to extract the variable from.
    DcpMutualAuthProcessingVariableId string
    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateField string
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId string
    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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_auth_processing_variable_id str
    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.
    certificateField String
    Specifies the field in the client certificate to extract the variable from.
    dcpMutualAuthProcessingVariableId String
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpDefaultAuthzGroups

    GroupNames 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    GroupNames []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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    groupNames 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    groupNames 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpDevRelations

    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomValues 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customValues 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    customValues 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDcpRealTimeAuth

    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExtractHostname bool
    Extracts a hostname from JWT.
    ExtractJurisdiction bool
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    ExtractNamespace bool
    Extracts a namespace from JSON web tokens (JWT).
    HostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    JurisdictionClaim 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.
    NamespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    extractHostname boolean
    Extracts a hostname from JWT.
    extractJurisdiction boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim string
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim string
    Specifies the claim in JWT to extract the namespace from.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    extractHostname Boolean
    Extracts a hostname from JWT.
    extractJurisdiction Boolean
    Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
    extractNamespace Boolean
    Extracts a namespace from JSON web tokens (JWT).
    hostnameClaim String
    Specifies the claim in JWT to extract the hostname from.
    jurisdictionClaim 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.
    namespaceClaim String
    Specifies the claim in JWT to extract the namespace from.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDeliveryReceipt

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDenyAccess

    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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason key to override the current behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 same reason 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 same reason key to override the current behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDenyDirectFailoverAccess

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicCacheId

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDeviceCharacteristicHeader

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDnsAsyncRefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorDnsPrefresh

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorDowngradeProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDownloadCompleteMarker

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDownloadNotification

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDownstreamCache

    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    AllowBehavior 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.
    SendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    SendPrivate bool
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    TemplateUuid string
    This option is for internal usage only.
    Ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.
    allowBehavior 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.
    sendHeaders string
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid string
    This option is for internal usage only.
    ttl string
    Sets the duration of the cache. Setting the value to 0 equates to a no-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 a no-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.
    allowBehavior 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.
    sendHeaders String
    Specifies the HTTP headers to include in the response to the client.
    sendPrivate Boolean
    Adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.
    templateUuid String
    This option is for internal usage only.
    ttl String
    Sets the duration of the cache. Setting the value to 0 equates to a no-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.

    GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorDynamicThroughtputOptimizationOverride

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorDynamicWebContent

    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ImageCompression 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.
    RealUserMonitoring bool
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    SureRoute bool
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    imageCompression 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.
    realUserMonitoring boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_monitoring bool
    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.
    imageCompression 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.
    realUserMonitoring Boolean
    Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.
    sureRoute Boolean
    Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEcmsBulkUpload

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDatabase

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    RegexPattern string
    Specifies the regular expression that matches the database name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern string
    Specifies the regular expression that matches the database name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the database name. By default, it points to database.
    regexPattern String
    Specifies the regular expression that matches the database name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEcmsDataset

    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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    ExtractLocation 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.
    HeaderName 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.
    QueryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    RegexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    extractLocation 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.
    headerName 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.
    queryParameterName string
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern string
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_name str
    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>.
    extractLocation 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.
    headerName 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.
    queryParameterName String
    Specifies the query string parameter that passed the data set name. By default, it points to dataset.
    regexPattern String
    Specifies the regular expression that matches the data set name in the URL.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEcmsObjectKey

    Locked bool
    Indicates 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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>.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeConnect

    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements List<string>
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AggregateLines string
    Specifies the maximum number of lines to include in each log.
    AggregateSize string
    Specifies the log's maximum size.
    AggregateTime string
    Specifies how often logs are generated.
    ApiConnector string
    Describes the API connector type.
    ApiDataElements []string
    Specifies the data set to log.
    DestinationHostname string
    Specifies the target hostname accepting push API requests.
    DestinationPath 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.
    OverrideAggregateSettings bool
    When enabled, overrides default log settings.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    aggregateLines string
    Specifies the maximum number of lines to include in each log.
    aggregateSize string
    Specifies the log's maximum size.
    aggregateTime string
    Specifies how often logs are generated.
    apiConnector string
    Describes the API connector type.
    apiDataElements string[]
    Specifies the data set to log.
    destinationHostname string
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings boolean
    When enabled, overrides default log settings.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_elements Sequence[str]
    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_settings bool
    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.
    aggregateLines String
    Specifies the maximum number of lines to include in each log.
    aggregateSize String
    Specifies the log's maximum size.
    aggregateTime String
    Specifies how often logs are generated.
    apiConnector String
    Describes the API connector type.
    apiDataElements List<String>
    Specifies the data set to log.
    destinationHostname String
    Specifies the target hostname accepting push API requests.
    destinationPath 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.
    overrideAggregateSettings Boolean
    When enabled, overrides default log settings.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenter

    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules List<GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    Description string
    Provides a description for the ELB data center, for your own reference.
    EnableFailover bool
    Allows you to specify failover rules.
    FailoverRules []GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenterFailoverRule
    Provides up to four failover rules to apply in the specified order.
    FailoverTitle 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.
    OriginId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenterFailoverRule>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description string
    Provides a description for the ELB data center, for your own reference.
    enableFailover boolean
    Allows you to specify failover rules.
    failoverRules GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenterFailoverRule[]
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId string
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_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[GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenterFailoverRule]
    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 the edgeLoadBalancingOrigin 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.
    cookieName String
    If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior's cookie_name option.
    description String
    Provides a description for the ELB data center, for your own reference.
    enableFailover Boolean
    Allows you to specify failover rules.
    failoverRules List<Property Map>
    Provides up to four failover rules to apply in the specified order.
    failoverTitle 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.
    originId String
    Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingDataCenterFailoverRule

    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    AbsolutePath 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.
    ContextRoot 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.
    FailoverHostname string
    The hostname of the data center to fail over to.
    ModifyRequest bool
    Allows you to modify the request's hostname or path.
    OverrideHostname bool
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.
    absolutePath 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.
    contextRoot 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.
    failoverHostname string
    The hostname of the data center to fail over to.
    modifyRequest boolean
    Allows you to modify the request's hostname or path.
    overrideHostname 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.
    absolutePath 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.
    contextRoot 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.
    failoverHostname String
    The hostname of the data center to fail over to.
    modifyRequest Boolean
    Allows you to modify the request's hostname or path.
    overrideHostname Boolean
    Overrides the request's hostname with the failover_hostname.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeLoadBalancingOrigin

    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    Description string
    Provides a description for the ELB origin, for your own reference.
    EnableSessionPersistence bool
    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 the edgeLoadBalancingDataCenter 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.
    SessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookieName string
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description string
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookie_name str
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description str
    Provides a description for the ELB origin, for your own reference.
    enable_session_persistence bool
    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 the edgeLoadBalancingDataCenter 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_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.
    cookieName String
    This specifies the name of the cookie that marks users' persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior's description option specifies the cookie's value.
    description String
    Provides a description for the ELB origin, for your own reference.
    enableSessionPersistence Boolean
    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 the edgeLoadBalancingDataCenter 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.
    sessionPersistenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeOriginAuthorization

    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CookieName 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookieName 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cookie_name 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.
    cookieName 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirector

    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirectorCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy 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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeRedirectorCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeScape

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeSideIncludes

    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets List<string>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DetectInjection bool
    Denies attempts to inject ESI code.
    EnableViaHttp bool
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    Enabled bool
    Enables ESI processing.
    I18nCharsets []string
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    I18nStatus 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.
    PassClientIp bool
    Allows edge servers to pass the client IP header to the ESI processor.
    PassSetCookie bool
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    detectInjection boolean
    Denies attempts to inject ESI code.
    enableViaHttp boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled boolean
    Enables ESI processing.
    i18nCharsets string[]
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_http bool
    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 and ISO-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_ip bool
    Allows edge servers to pass the client IP header to the ESI processor.
    pass_set_cookie 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.
    detectInjection Boolean
    Denies attempts to inject ESI code.
    enableViaHttp Boolean
    Enable ESI only for content featuring the Edge-control: dca=esi HTTP response header.
    enabled Boolean
    Enables ESI processing.
    i18nCharsets List<String>
    Specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.
    i18nStatus 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.
    passClientIp Boolean
    Allows edge servers to pass the client IP header to the ESI processor.
    passSetCookie Boolean
    Allows edge servers to pass your origin server's cookies to the ESI processor.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEdgeWorker

    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CreateEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    EdgeWorkerId string
    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.
    MPulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    MPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    createEdgeWorker string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId string
    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.
    mPulse boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_worker str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edge_worker_id str
    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.
    m_pulse bool
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    m_pulse_information str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    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.
    createEdgeWorker String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    edgeWorkerId String
    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.
    mPulse Boolean
    Enables mPulse reports that include data about EdgeWorkers errors generated due to JavaScript errors. For more details, see Integrate mPulse reports with EdgeWorkers.
    mPulseInformation String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    resourceTier String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEnforceMtlsSettings

    CertificateAuthoritySets List<string>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CertificateAuthoritySets []string
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    EnableAuthSet bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    EnableDenyRequest bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    EnableOcspStatus bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    certificateAuthoritySets string[]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_authority_sets Sequence[str]
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enable_auth_set bool
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enable_deny_request bool
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enable_ocsp_status bool
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked bool
    Indicates that your 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.
    certificateAuthoritySets List<String>
    Specify the client certificate authority (CA) sets you want to support in client requests. Run the List CA Sets operation in the mTLS Edge TrustStore API to get the setId value and pass it in this option as a string. If a request includes a set not defined here, it will be denied. The preset list items you can select are contingent on the CA sets you've created using the mTLS Edge Truststore, and then associated with a certificate in the Certificate Provisioning System.
    enableAuthSet Boolean
    Whether to require a specific mutual transport layer security (mTLS) certificate authority (CA) set in a request from a client to the edge network.
    enableDenyRequest Boolean
    This denies a request from a client that doesn't match what you've set for the options in this behavior. When disabled, non-matching requests are allowed, but you can incorporate a custom handling operation, such as reviewing generated log entries to see the discrepancies, enable the Client-To-Edge authentication header, or issue a custom message.
    enableOcspStatus Boolean
    Whether the mutual transport layer security requests from a client should use the online certificate support protocol (OCSP). OCSP can determine the x.509 certificate revocation status during the TLS handshake.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedAkamaiProtocol

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorEnhancedProxyDetection

    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AnonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    BestPracticeAction string
    Specifies how to field the proxy request.
    BestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectAnonymousVpn bool
    This enables detection of requests from anonymous VPNs.
    DetectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    DetectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    DetectHostingProvider bool
    This detects requests from a hosting provider.
    DetectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    DetectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    DetectPublicProxy bool
    This enables detection of requests from public proxies.
    DetectPublicProxyAction string
    Specifies how to field public proxy requests.
    DetectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    DetectResidentialProxy bool
    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.
    DetectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    DetectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    DetectSmartDnsProxy bool
    This enables detection of requests from smart DNS proxies.
    DetectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    DetectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    DetectTorExitNode bool
    This enables detection of requests from Tor exit nodes.
    DetectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    DetectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    DetectVpnDataCenter bool
    This enables detection of requests from VPN data centers.
    DetectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    DetectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    EnableConfigurationMode string
    Specifies how to field the proxy request.
    Enabled bool
    Applies GeoGuard proxy detection.
    ForwardHeaderEnrichment bool
    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.
    HostingProvider 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.
    PublicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ResidentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SmartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TorExitNode 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.
    VpnDataCenter string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction string
    Specifies how to field the proxy request.
    bestPracticeRedirecturl string
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction string
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl string
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl string
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction string
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl string
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy boolean
    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.
    detectResidentialProxyAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl string
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction string
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl string
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl string
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction string
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl string
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode string
    Specifies how to field the proxy request.
    enabled boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment boolean
    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.
    hostingProvider 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.
    publicProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter string
    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_action str
    Specifies how to field the proxy request.
    best_practice_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_anonymous_vpn bool
    This enables detection of requests from anonymous VPNs.
    detect_anonymous_vpn_action str
    Specifies how to field anonymous VPN requests.
    detect_anonymous_vpn_redirecturl str
    This specifies the URL to which to redirect anonymous VPN requests.
    detect_hosting_provider bool
    This detects requests from a hosting provider.
    detect_hosting_provider_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detect_hosting_provider_redirecturl str
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detect_public_proxy bool
    This enables detection of requests from public proxies.
    detect_public_proxy_action str
    Specifies how to field public proxy requests.
    detect_public_proxy_redirecturl str
    This specifies the URL to which to redirect public proxy requests.
    detect_residential_proxy bool
    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_proxy_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detect_residential_proxy_redirecturl str
    This specifies the URL to which to redirect requests.
    detect_smart_dns_proxy bool
    This enables detection of requests from smart DNS proxies.
    detect_smart_dns_proxy_action str
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detect_smart_dns_proxy_redirecturl str
    This specifies the URL to which to redirect DNS proxy requests.
    detect_tor_exit_node bool
    This enables detection of requests from Tor exit nodes.
    detect_tor_exit_node_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detect_tor_exit_node_redirecturl str
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detect_vpn_data_center bool
    This enables detection of requests from VPN data centers.
    detect_vpn_data_center_action str
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detect_vpn_data_center_redirecturl str
    This specifies the URL to which to redirect requests from VPN data centers.
    enable_configuration_mode str
    Specifies how to field the proxy request.
    enabled bool
    Applies GeoGuard proxy detection.
    forward_header_enrichment bool
    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_proxy 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.
    tor_exit_node 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.
    vpn_data_center str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    anonymousVpn String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    bestPracticeAction String
    Specifies how to field the proxy request.
    bestPracticeRedirecturl String
    This specifies the URL to which to redirect requests.
    detectAnonymousVpn Boolean
    This enables detection of requests from anonymous VPNs.
    detectAnonymousVpnAction String
    Specifies how to field anonymous VPN requests.
    detectAnonymousVpnRedirecturl String
    This specifies the URL to which to redirect anonymous VPN requests.
    detectHostingProvider Boolean
    This detects requests from a hosting provider.
    detectHostingProviderAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from hosting providers.
    detectHostingProviderRedirecturl String
    This specifies the absolute URL to which to redirect requests from hosting providers.
    detectPublicProxy Boolean
    This enables detection of requests from public proxies.
    detectPublicProxyAction String
    Specifies how to field public proxy requests.
    detectPublicProxyRedirecturl String
    This specifies the URL to which to redirect public proxy requests.
    detectResidentialProxy Boolean
    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.
    detectResidentialProxyAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from residential proxies.
    detectResidentialProxyRedirecturl String
    This specifies the URL to which to redirect requests.
    detectSmartDnsProxy Boolean
    This enables detection of requests from smart DNS proxies.
    detectSmartDnsProxyAction String
    Specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.
    detectSmartDnsProxyRedirecturl String
    This specifies the URL to which to redirect DNS proxy requests.
    detectTorExitNode Boolean
    This enables detection of requests from Tor exit nodes.
    detectTorExitNodeAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.
    detectTorExitNodeRedirecturl String
    This specifies the URL to which to redirect requests from Tor exit nodes.
    detectVpnDataCenter Boolean
    This enables detection of requests from VPN data centers.
    detectVpnDataCenterAction String
    This specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.
    detectVpnDataCenterRedirecturl String
    This specifies the URL to which to redirect requests from VPN data centers.
    enableConfigurationMode String
    Specifies how to field the proxy request.
    enabled Boolean
    Applies GeoGuard proxy detection.
    forwardHeaderEnrichment Boolean
    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.
    hostingProvider 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.
    publicProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    residentialProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    smartDnsProxy String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    torExitNode 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.
    vpnDataCenter String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorEpdForwardHeaderEnrichment

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFailAction

    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20240212BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ActionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    AllowFcmParentOverride bool
    CexCustomPath bool
    Specifies a custom path.
    CexHostname string
    Specifies a hostname.
    CexPath string
    Specifies a custom path.
    ContentCustomPath bool
    Specifies a custom redirect path.
    ContentHostname string
    Specifies the static hostname for the alternate redirect.
    ContentPath string
    Specifies a custom redirect path.
    CpCode GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    DynamicCustomPath bool
    Allows you to modify the original requested path.
    DynamicMethod string
    Specifies the redirect method.
    DynamicPath 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.
    ModifyProtocol bool
    Modifies the redirect's protocol using the value of the protocol field.
    NetStorageHostname GetPropertyRulesBuilderRulesV20240212BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    NetStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    PreserveQueryString bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    Protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    RedirectCustomPath bool
    Uses the redirectPath to customize a new path.
    RedirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    RedirectHostnameType string
    Whether to preserve or customize the hostname.
    RedirectMethod int
    Specifies the HTTP response code.
    RedirectPath string
    Specifies a new path.
    SaasCnameEnabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    SaasCnameLevel int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    SaasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    SaasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    SaasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    SaasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    StatusCode int
    Assigns a new HTTP status code to the failure response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20240212BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Integer
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Integer
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Integer
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    actionType string
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride boolean
    cexCustomPath boolean
    Specifies a custom path.
    cexHostname string
    Specifies a hostname.
    cexPath string
    Specifies a custom path.
    contentCustomPath boolean
    Specifies a custom redirect path.
    contentHostname string
    Specifies the static hostname for the alternate redirect.
    contentPath string
    Specifies a custom redirect path.
    cpCode GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath boolean
    Allows you to modify the original requested path.
    dynamicMethod string
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname GetPropertyRulesBuilderRulesV20240212BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath string
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol string
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath boolean
    Uses the redirectPath to customize a new path.
    redirectHostname string
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType string
    Whether to preserve or customize the hostname.
    redirectMethod number
    Specifies the HTTP response code.
    redirectPath string
    Specifies a new path.
    saasCnameEnabled boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex string
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace string
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix string
    Specifies the static portion of the SaaS dynamic failaction.
    saasType string
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode number
    Assigns a new HTTP status code to the failure response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_parent_override bool
    cex_custom_path bool
    Specifies a custom path.
    cex_hostname str
    Specifies a hostname.
    cex_path str
    Specifies a custom path.
    content_custom_path bool
    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 GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCode
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamic_custom_path bool
    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_hostname GetPropertyRulesBuilderRulesV20240212BehaviorFailActionNetStorageHostname
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    net_storage_path str
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserve_query_string bool
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol str
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirect_custom_path bool
    Uses the redirectPath to customize a new path.
    redirect_hostname str
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirect_hostname_type str
    Whether to preserve or customize the hostname.
    redirect_method int
    Specifies the HTTP response code.
    redirect_path str
    Specifies a new path.
    saas_cname_enabled bool
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saas_cname_level int
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saas_query_string str
    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.
    actionType String
    Specifies the basic action to take when there is a failure to contact the origin.
    allowFcmParentOverride Boolean
    cexCustomPath Boolean
    Specifies a custom path.
    cexHostname String
    Specifies a hostname.
    cexPath String
    Specifies a custom path.
    contentCustomPath Boolean
    Specifies a custom redirect path.
    contentHostname String
    Specifies the static hostname for the alternate redirect.
    contentPath String
    Specifies a custom redirect path.
    cpCode Property Map
    Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    dynamicCustomPath Boolean
    Allows you to modify the original requested path.
    dynamicMethod String
    Specifies the redirect method.
    dynamicPath 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.
    modifyProtocol Boolean
    Modifies the redirect's protocol using the value of the protocol field.
    netStorageHostname Property Map
    When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's id.
    netStoragePath String
    When the actionType is RECREATED_NS, specifies the path for the NetStorage request.
    preserveQueryString Boolean
    When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request's query string as part of the path.
    protocol String
    When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect's protocol.
    redirectCustomPath Boolean
    Uses the redirectPath to customize a new path.
    redirectHostname String
    When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.
    redirectHostnameType String
    Whether to preserve or customize the hostname.
    redirectMethod Number
    Specifies the HTTP response code.
    redirectPath String
    Specifies a new path.
    saasCnameEnabled Boolean
    Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
    saasCnameLevel Number
    Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic failaction.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
    saasRegex String
    Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
    saasReplace String
    Specifies the replacement pattern that defines the SaaS dynamic failaction.
    saasSuffix String
    Specifies the static portion of the SaaS dynamic failaction.
    saasType String
    Identifies the component of the request that identifies the SaaS dynamic fail action.
    statusCode Number
    Assigns a new HTTP status code to the failure response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorFailActionCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorFailActionNetStorageHostname

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240212BehaviorFailoverBotManagerFeatureCompatibility

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFastInvalidate

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFips

    Enable bool
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    enable Boolean
    When enabled, supports the use of FIPS-validated ciphers in the connection between this delivery configuration and your 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketing

    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlus

    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    JavaScriptInsertionRule string
    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.
    MediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule string
    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.
    mediaMathPrefix string
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlusCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Cloud Marketing Plus Cloudlet.
    java_script_insertion_rule str
    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_prefix str
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Cloud Marketing Plus Cloudlet.
    javaScriptInsertionRule String
    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.
    mediaMathPrefix String
    Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorFirstPartyMarketingPlusCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewrite

    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy 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.
    IsSharedPolicy 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewriteCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_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.
    is_shared_policy 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.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy 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.
    isSharedPolicy 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorForwardRewriteCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorG2oheader

    CustomSignStrings List<string>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    CustomSignStrings []string
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    DataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    Enabled bool
    Enables the g2o verification behavior.
    EncodingVersion int
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    Locked bool
    Indicates 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.
    SecretKey string
    Specifies the shared secret key.
    SignedHeader string
    Specifies the name of the header containing encrypted request data.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Integer
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customSignStrings string[]
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader string
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled boolean
    Enables the g2o verification behavior.
    encodingVersion number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked boolean
    Indicates 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.
    secretKey string
    Specifies the shared secret key.
    signedHeader string
    Specifies the name of the header containing encrypted request data.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_strings Sequence[str]
    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 through 5.
    locked bool
    Indicates 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_sign_string bool
    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.
    customSignStrings List<String>
    Specifies the set of data to be encrypted as a combination of concatenated strings.
    dataHeader String
    Specifies the name of the header that contains the request data that needs to be encrypted.
    enabled Boolean
    Enables the g2o verification behavior.
    encodingVersion Number
    Specifies the version of the encryption algorithm as an integer from 1 through 5.
    locked Boolean
    Indicates 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.
    secretKey String
    Specifies the shared secret key.
    signedHeader String
    Specifies the name of the header containing encrypted request data.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorGlobalRequestNumber

    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    HeaderName 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.
    OutputOption string
    Specifies how to report the GRN value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption string
    Specifies how to report the GRN value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.
    headerName 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.
    outputOption String
    Specifies how to report the GRN value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorGraphqlCaching

    Advanced string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    CacheResponsesWithErrors bool
    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.
    OperationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    OperationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    PostRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    cacheResponsesWithErrors boolean
    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.
    operationsJsonBodyParameterName string
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName string
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling string
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_with_errors bool
    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_body_parameter_name str
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operations_url_query_parameter_name str
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    post_request_processing_error_handling str
    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.
    cacheResponsesWithErrors Boolean
    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.
    operationsJsonBodyParameterName String
    The name of the JSON body parameter that identifies GraphQL POST requests.
    operationsUrlQueryParameterName String
    Specifies the name of a query parameter that identifies requests as GraphQL queries.
    postRequestProcessingErrorHandling String
    Specify what happens if GraphQL query processing fails on POST requests.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorGzipResponse

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorHdDataAdvanced

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorHealthDetection

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumReconnects 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 of retryCount.
    RetryCount int
    The number of consecutive connection failures that mark an IP address as faulty.
    RetryInterval 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects 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 of retryCount.
    retryCount Integer
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumReconnects number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 of retryCount.
    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.
    maximumReconnects Number
    Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.
    retryCount Number
    The number of consecutive connection failures that mark an IP address as faulty.
    retryInterval 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorHsafEipBinding

    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    CustomExtractedSerial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    Enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    HashMaxValue int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    HashMinValue int
    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.
    TemplateUuid 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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Integer
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Integer
    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.
    templateUuid 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.
    customExtractedSerial boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue number
    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.
    templateUuid 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_serial bool
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled bool
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hash_max_value int
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hash_min_value int
    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.
    customExtractedSerial Boolean
    Whether to pull the serial number from the variable value set in the advanced behavior. Work with your Akamai Services team to add the advanced behavior earlier in your property to extract and apply the AKA_PM_EIP_HSAF_SERIAL variable.
    enabled Boolean
    Enables HSAF for Edge IP Binding customers with a large footprint.
    hashMaxValue Number
    Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than hashMinValue.
    hashMinValue Number
    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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorHttp2

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorHttp3

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorHttpStrictTransportSecurity

    Enable bool
    Applies HSTS to this set of requests.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    IncludeSubDomains bool
    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.
    MaxAge 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.
    RedirectStatusCode int
    Specifies a response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Integer
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    includeSubDomains boolean
    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.
    maxAge 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.
    redirectStatusCode number
    Specifies a response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_domains bool
    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_code int
    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.
    includeSubDomains Boolean
    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.
    maxAge 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.
    redirectStatusCode Number
    Specifies a response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorHttpToHttpsUpgrade

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImOverride

    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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters List<string>
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    ExcludeAllQueryParameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    ExcludedQueryParameters []string
    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.
    PolicyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    PolicyvarName 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.
    TemplateUuid 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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.
    excludeAllQueryParameters boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters string[]
    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.
    policyvarIMvar string
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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_query_parameters bool
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excluded_query_parameters Sequence[str]
    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_mvar str
    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.
    excludeAllQueryParameters Boolean
    Whether to exclude all query parameters from the Image and Video Manager cache key.
    excludedQueryParameters List<String>
    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.
    policyvarIMvar String
    This selects one of the property's rule tree variables to assign to the policyvarName variable within Image and Video Manager.
    policyvarName 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManager

    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    ApplyBestFileType bool
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginal
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformed
    Enabled bool
    ImageSet 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.
    PolicySetType string
    Resize bool
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VideoSet string
    applyBestFileType Boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformed
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String
    applyBestFileType boolean
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginal
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformed
    enabled boolean
    imageSet 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.
    policySetType string
    resize boolean
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet string
    apply_best_file_type bool
    cp_code_original GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginal
    cp_code_transformed GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformed
    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_type str
    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
    applyBestFileType Boolean
    cpCodeOriginal Property Map
    cpCodeTransformed Property Map
    enabled Boolean
    imageSet 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.
    policySetType String
    resize Boolean
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    videoSet String

    GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManager

    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    api_reference_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginal
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformed
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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_default str
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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_region str
    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_policy_set bool
    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 (the policyToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.
    cpCodeOriginal Property Map
    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 any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideo

    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    ApiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ApplyBestFileType bool
    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.
    CpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    CpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    PolicySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    PolicyToken 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.
    PolicyTokenDefault string
    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.
    SettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SuperCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    TemplateUuid string
    This option is for internal usage only.
    TrafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseExistingPolicySet bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.
    apiReferenceTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet string
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault string
    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.
    settingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion string
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid string
    This option is for internal usage only.
    trafficTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet boolean
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    apply_best_file_type bool
    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_original GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginal
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cp_code_transformed GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformed
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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_default str
    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_region str
    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_policy_set bool
    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.
    apiReferenceTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    applyBestFileType Boolean
    When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.
    cpCodeOriginal Property Map
    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 initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    cpCodeTransformed Property Map
    Specifies the CP code to identify derivative transformed video content. You only need to provide the initial id, stripping any cpc_ 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.
    policySet String
    Identifies the existing policy set configured with Image and Video Manager API.
    policyToken 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.
    policyTokenDefault String
    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.
    settingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    superCacheRegion String
    To optimize caching, assign a region close to your site's heaviest traffic.
    templateUuid String
    This option is for internal usage only.
    trafficTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useExistingPolicySet Boolean
    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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginal

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformed

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorInclude

    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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 the inc_ 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 the inc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorInstant

    CustomLinkRelations List<string>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions List<string>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLinkRelations []string
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    PrefetchCacheable bool
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    PrefetchHtml 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.
    PrefetchNoStore bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    PrefetchNoStoreExtensions []string
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLinkRelations string[]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions string[]
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_relations Sequence[str]
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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 the tieredDistribution 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_store bool
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetch_no_store_extensions Sequence[str]
    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.
    customLinkRelations List<String>
    Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="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.
    prefetchCacheable Boolean
    When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.
    prefetchHtml 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.
    prefetchNoStore Boolean
    Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.
    prefetchNoStoreExtensions List<String>
    Specifies a set of file extensions for which the prefetchNoStore option is allowed.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorInstantConfig

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimization

    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnablePartialObjectCaching string
    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.
    MaximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    MinimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    TemplateUuid string
    This option is for internal usage only.
    UseVersioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enablePartialObjectCaching string
    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.
    maximumSize string
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize string
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid string
    This option is for internal usage only.
    useVersioning boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_object_caching str
    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 or GB. 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 or GB.
    template_uuid str
    This option is for internal usage only.
    use_versioning bool
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    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.
    enablePartialObjectCaching String
    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.
    maximumSize String
    Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB. 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.
    minimumSize String
    Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.
    templateUuid String
    This option is for internal usage only.
    useVersioning Boolean
    When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorLargeFileOptimizationAdvanced

    Enabled bool
    Enables the file optimization behavior.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    FragmentSize 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.
    ObjectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    PrefetchAfterRequest int
    The number of POC fragments to prefetch after the request.
    PrefetchDuringRequest int
    The number of POC fragments to prefetch during the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Integer
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Integer
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    fragmentSize 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.
    objectSize string
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest number
    The number of POC fragments to prefetch during the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or GB suffix.
    prefetch_after_request int
    The number of POC fragments to prefetch after the request.
    prefetch_during_request int
    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.
    fragmentSize 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.
    objectSize String
    Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.
    prefetchAfterRequest Number
    The number of POC fragments to prefetch after the request.
    prefetchDuringRequest Number
    The number of POC fragments to prefetch during the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRate

    BitrateTables List<GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables List<GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BitrateTables []GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateBitrateTable
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    TemplateUuid string
    This option is for internal usage only.
    ThresholdTables []GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateThresholdTable
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables List<GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateBitrateTable>
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables List<GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateThresholdTable>
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bitrateTables GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateBitrateTable[]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid string
    This option is for internal usage only.
    thresholdTables GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateThresholdTable[]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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[GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateBitrateTable]
    Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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[GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateThresholdTable]
    Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    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.
    bitrateTables 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 numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps.
    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.
    templateUuid String
    This option is for internal usage only.
    thresholdTables 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 numeric thresholdValue and thresholdUnit string, with allowed values of SECONDS or BYTES.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateBitrateTable

    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue double
    The numeric indicator of the download rate.
    BitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    BitrateValue float64
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Double
    The numeric indicator of the download rate.
    bitrateUnit string
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue number
    The numeric indicator of the download rate.
    bitrate_unit str
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrate_value float
    The numeric indicator of the download rate.
    bitrateUnit String
    The unit of measurement, either KBPS, MBPS, or GBPS.
    bitrateValue Number
    The numeric indicator of the download rate.

    GetPropertyRulesBuilderRulesV20240212BehaviorLimitBitRateThresholdTable

    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    ThresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    ThresholdValue int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Integer
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit string
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue 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, or BYTES of the file size.
    threshold_value int
    The numeric indicator of the minimum file size or elapsed download time.
    thresholdUnit String
    The unit of measurement, either SECONDS of the elapsed download time, or BYTES of the file size.
    thresholdValue Number
    The numeric indicator of the minimum file size or elapsed download time.

    GetPropertyRulesBuilderRulesV20240212BehaviorLogCustom

    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customLogField string
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_field str
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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_log_field bool
    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.
    customLogField String
    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. See Support for variables for more information. Since this option can specify both a request and response, it overrides any customLogField settings in the report 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.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMPulse

    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    ApiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    BufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    ConfigOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    Enabled bool
    Applies performance monitoring to this behavior's set of content.
    LoaderVersion 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.
    RequirePci bool
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    TemplateUuid string
    This option is for internal usage only.
    TitleOptional 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.
    apiKey string
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize string
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride string
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid string
    This option is for internal usage only.
    titleOptional 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}}". See Configuration 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.
    apiKey String
    This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.
    bufferSize String
    Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
    configOverride String
    A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.
    enabled Boolean
    Applies performance monitoring to this behavior's set of content.
    loaderVersion 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.
    requirePci Boolean
    Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
    templateUuid String
    This option is for internal usage only.
    titleOptional 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorManifestPersonalization

    Enabled bool
    Enables the Manifest Personalization feature.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    HlsEnableDebugHeaders bool
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    HlsEnabled bool
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    HlsFilterInBitrateRanges string
    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.
    HlsFilterInBitrates string
    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.
    HlsMode string
    Applies with hlsEnabled on.
    HlsPreferredBitrate string
    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.
    HlsQueryParamEnabled bool
    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.
    HlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    HlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    HlsShowAdvanced bool
    Allows you to configure advanced settings.
    HlsTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    hlsEnableDebugHeaders boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges string
    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.
    hlsFilterInBitrates string
    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.
    hlsMode string
    Applies with hlsEnabled on.
    hlsPreferredBitrate string
    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.
    hlsQueryParamEnabled boolean
    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.
    hlsQueryParamSecretKey string
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey string
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_debug_headers bool
    Includes additional Akamai-Manifest-Personalization and Akamai-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_in_bitrate_ranges str
    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_in_bitrates str
    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_bitrate str
    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_param_enabled bool
    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_param_secret_key str
    Specifies a primary key as a token to accompany the request.
    hls_query_param_transition_key str
    Specifies a transition key as a token to accompany the request.
    hls_show_advanced bool
    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.
    hlsEnableDebugHeaders Boolean
    Includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.
    hlsEnabled Boolean
    Allows you to customize the HLS master manifest that's sent to the requesting client.
    hlsFilterInBitrateRanges String
    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.
    hlsFilterInBitrates String
    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.
    hlsMode String
    Applies with hlsEnabled on.
    hlsPreferredBitrate String
    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.
    hlsQueryParamEnabled Boolean
    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.
    hlsQueryParamSecretKey String
    Specifies a primary key as a token to accompany the request.
    hlsQueryParamTransitionKey String
    Specifies a transition key as a token to accompany the request.
    hlsShowAdvanced Boolean
    Allows you to configure advanced settings.
    hlsTitle 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorManifestRerouting

    Locked bool
    Indicates 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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorManualServerPush

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMediaAcceleration

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMediaAccelerationQuicOptout

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMediaClient

    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    BeaconId 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.
    TemplateUuid string
    This option is for internal usage only.
    UseHybridHttpUdp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.
    beaconId 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.
    templateUuid string
    This option is for internal usage only.
    useHybridHttpUdp boolean
    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_http_udp bool
    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.
    beaconId 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.
    templateUuid String
    This option is for internal usage only.
    useHybridHttpUdp Boolean
    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.

    GetPropertyRulesBuilderRulesV20240212BehaviorMediaFileRetrievalOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMediaOriginFailover

    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes List<string>
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CacheErrorResponse bool
    When enabled, caches the error response.
    CacheWindow string
    This sets error response's TTL.
    ClientResponseCode string
    Specifies the response code served to the client.
    DetectObjectUnavailable bool
    Allows you to configure failover settings when the origin has content errors.
    DetectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    DetectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    DetectOriginUnresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    DetectOriginUnresponsiveTitle 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.
    ObjectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    ObjectUnavailableBackupHost string
    This specifies the origin hostname.
    ObjectUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    ObjectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    ObjectUnavailableChangeProtocol bool
    Changes the request protocol.
    ObjectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    ObjectUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    ObjectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    ObjectUnavailableModifyRequestPath bool
    Enabling this allows you to modify the request path.
    ObjectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    ObjectUnavailableRecovery string
    This sets the recovery option.
    ObjectUnavailableRedirectMethod int
    Specifies a redirect response code.
    ObjectUnavailableResponseCodes []string
    Specifies the set of response codes identifying when there are content errors.
    ObjectUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnavailableBackupHost string
    This specifies the origin hostname.
    OriginUnavailableBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnavailableChangeProtocol bool
    Modifies the request protocol.
    OriginUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    OriginUnavailableIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnavailableModifiedPath string
    This specifies the path to form the new URL.
    OriginUnavailableModifyRequestPath bool
    Modifies the request path.
    OriginUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    OriginUnavailableRecovery string
    This sets the recovery option.
    OriginUnavailableRedirectMethod int
    Specifies either a redirect response code.
    OriginUnavailableResponseCodes []string
    Specifies the set of response codes identifying when the origin responds with errors.
    OriginUnavailableRetryLimit string
    Sets how many times to retry.
    OriginUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    OriginUnresponsiveBackupHost string
    This specifies the origin hostname.
    OriginUnresponsiveBlacklistOriginIp bool
    Enabling this blacklists the origin's IP address.
    OriginUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    OriginUnresponsiveChangeProtocol bool
    This allows you to change the request protocol.
    OriginUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    OriginUnresponsiveIncludeQueryString bool
    Enabling this includes the original set of query parameters.
    OriginUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    OriginUnresponsiveModifyRequestPath bool
    Modifies the request path.
    OriginUnresponsiveProtocol string
    Specifies which protocol to use.
    OriginUnresponsiveRecovery string
    This sets the recovery option.
    OriginUnresponsiveRedirectMethod int
    Specifies the redirect response code.
    OriginUnresponsiveRetryLimit string
    Sets how many times to retry.
    OtherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Integer
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Integer
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Integer
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cacheErrorResponse boolean
    When enabled, caches the error response.
    cacheWindow string
    This sets error response's TTL.
    clientResponseCode string
    Specifies the response code served to the client.
    detectObjectUnavailable boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost string
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath string
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery string
    This sets the recovery option.
    objectUnavailableRedirectMethod number
    Specifies a redirect response code.
    objectUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit string
    Sets how many times to retry.
    originUnavailableAlternateHost string
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost string
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel string
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath string
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath boolean
    Modifies the request path.
    originUnavailableProtocol string
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery string
    This sets the recovery option.
    originUnavailableRedirectMethod number
    Specifies either a redirect response code.
    originUnavailableResponseCodes string[]
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit string
    Sets how many times to retry.
    originUnresponsiveAlternateHost string
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost string
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow string
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel string
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath string
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath boolean
    Modifies the request path.
    originUnresponsiveProtocol string
    Specifies which protocol to use.
    originUnresponsiveRecovery string
    This sets the recovery option.
    originUnresponsiveRedirectMethod number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit string
    Sets how many times to retry.
    otherOptions string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_response bool
    When enabled, caches the error response.
    cache_window str
    This sets error response's TTL.
    client_response_code str
    Specifies the response code served to the client.
    detect_object_unavailable bool
    Allows you to configure failover settings when the origin has content errors.
    detect_object_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unavailable bool
    Allows you to configure failover settings when the origin server responds with errors.
    detect_origin_unavailable_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detect_origin_unresponsive bool
    Allows you to configure what happens when the origin is unresponsive.
    detect_origin_unresponsive_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.
    object_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    object_unavailable_backup_host str
    This specifies the origin hostname.
    object_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    object_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    object_unavailable_change_protocol bool
    Changes the request protocol.
    object_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    object_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    object_unavailable_modified_path str
    This specifies the path to form the new URL.
    object_unavailable_modify_request_path bool
    Enabling this allows you to modify the request path.
    object_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    object_unavailable_recovery str
    This sets the recovery option.
    object_unavailable_redirect_method int
    Specifies a redirect response code.
    object_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when there are content errors.
    object_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unavailable_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unavailable_backup_host str
    This specifies the origin hostname.
    origin_unavailable_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unavailable_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unavailable_change_protocol bool
    Modifies the request protocol.
    origin_unavailable_detection_level str
    Specify RESPONSE_CODES, the only available option.
    origin_unavailable_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unavailable_modified_path str
    This specifies the path to form the new URL.
    origin_unavailable_modify_request_path bool
    Modifies the request path.
    origin_unavailable_protocol str
    Specifies either the HTTP or HTTPS protocol.
    origin_unavailable_recovery str
    This sets the recovery option.
    origin_unavailable_redirect_method int
    Specifies either a redirect response code.
    origin_unavailable_response_codes Sequence[str]
    Specifies the set of response codes identifying when the origin responds with errors.
    origin_unavailable_retry_limit str
    Sets how many times to retry.
    origin_unresponsive_alternate_host str
    This specifies the redirect's destination hostname.
    origin_unresponsive_backup_host str
    This specifies the origin hostname.
    origin_unresponsive_blacklist_origin_ip bool
    Enabling this blacklists the origin's IP address.
    origin_unresponsive_blacklist_window str
    This sets the delay before blacklisting an IP address.
    origin_unresponsive_change_protocol bool
    This allows you to change the request protocol.
    origin_unresponsive_detection_level str
    Specify the level of response to slow origin connections.
    origin_unresponsive_include_query_string bool
    Enabling this includes the original set of query parameters.
    origin_unresponsive_modified_path str
    This specifies the path to form the new URL.
    origin_unresponsive_modify_request_path bool
    Modifies the request path.
    origin_unresponsive_protocol str
    Specifies which protocol to use.
    origin_unresponsive_recovery str
    This sets the recovery option.
    origin_unresponsive_redirect_method int
    Specifies the redirect response code.
    origin_unresponsive_retry_limit str
    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.
    cacheErrorResponse Boolean
    When enabled, caches the error response.
    cacheWindow String
    This sets error response's TTL.
    clientResponseCode String
    Specifies the response code served to the client.
    detectObjectUnavailable Boolean
    Allows you to configure failover settings when the origin has content errors.
    detectObjectUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnavailable Boolean
    Allows you to configure failover settings when the origin server responds with errors.
    detectOriginUnavailableTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    detectOriginUnresponsive Boolean
    Allows you to configure what happens when the origin is unresponsive.
    detectOriginUnresponsiveTitle 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.
    objectUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    objectUnavailableBackupHost String
    This specifies the origin hostname.
    objectUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    objectUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    objectUnavailableChangeProtocol Boolean
    Changes the request protocol.
    objectUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    objectUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    objectUnavailableModifiedPath String
    This specifies the path to form the new URL.
    objectUnavailableModifyRequestPath Boolean
    Enabling this allows you to modify the request path.
    objectUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    objectUnavailableRecovery String
    This sets the recovery option.
    objectUnavailableRedirectMethod Number
    Specifies a redirect response code.
    objectUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when there are content errors.
    objectUnavailableRetryLimit String
    Sets how many times to retry.
    originUnavailableAlternateHost String
    This specifies the redirect's destination hostname.
    originUnavailableBackupHost String
    This specifies the origin hostname.
    originUnavailableBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnavailableBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnavailableChangeProtocol Boolean
    Modifies the request protocol.
    originUnavailableDetectionLevel String
    Specify RESPONSE_CODES, the only available option.
    originUnavailableIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnavailableModifiedPath String
    This specifies the path to form the new URL.
    originUnavailableModifyRequestPath Boolean
    Modifies the request path.
    originUnavailableProtocol String
    Specifies either the HTTP or HTTPS protocol.
    originUnavailableRecovery String
    This sets the recovery option.
    originUnavailableRedirectMethod Number
    Specifies either a redirect response code.
    originUnavailableResponseCodes List<String>
    Specifies the set of response codes identifying when the origin responds with errors.
    originUnavailableRetryLimit String
    Sets how many times to retry.
    originUnresponsiveAlternateHost String
    This specifies the redirect's destination hostname.
    originUnresponsiveBackupHost String
    This specifies the origin hostname.
    originUnresponsiveBlacklistOriginIp Boolean
    Enabling this blacklists the origin's IP address.
    originUnresponsiveBlacklistWindow String
    This sets the delay before blacklisting an IP address.
    originUnresponsiveChangeProtocol Boolean
    This allows you to change the request protocol.
    originUnresponsiveDetectionLevel String
    Specify the level of response to slow origin connections.
    originUnresponsiveIncludeQueryString Boolean
    Enabling this includes the original set of query parameters.
    originUnresponsiveModifiedPath String
    This specifies the path to form the new URL.
    originUnresponsiveModifyRequestPath Boolean
    Modifies the request path.
    originUnresponsiveProtocol String
    Specifies which protocol to use.
    originUnresponsiveRecovery String
    This sets the recovery option.
    originUnresponsiveRedirectMethod Number
    Specifies the redirect response code.
    originUnresponsiveRetryLimit String
    Sets how many times to retry.
    otherOptions String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMetadataCaching

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorMobileSdkPerformance

    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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    SecondaryMultipathToOrigin bool
    When enabled, sends secondary multi-path requests to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    secondaryMultipathToOrigin boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to_origin bool
    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.
    secondaryMultipathToOrigin Boolean
    When enabled, sends secondary multi-path requests to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingRequestHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Supplies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Supplies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP request headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Supplies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP request headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Supplies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorModifyIncomingResponseHeader

    Action string
    Either ADD, DELETE, MODIFY, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    StandardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName string
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, or PASS incoming HTTP response headers.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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_value str
    Specifies an HTTP header replacement value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standard_pass_header_name str
    If the value of action is PASS, 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, or PASS incoming HTTP response headers.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY, this specifies the name of the field to modify.
    standardPassHeaderName String
    If the value of action is PASS, this specifies the name of the field to pass through.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingRequestHeader

    Action string
    Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies an HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies an HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies an HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies an HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorModifyOutgoingResponseHeader

    Action string
    Either ADD or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    AvoidDuplicateHeaders bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    CustomHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    HeaderValue 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.
    MatchMultiple bool
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    NewHeaderValue string
    Specifies the new HTTP header replacement value.
    RegexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    RegexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    StandardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    StandardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    StandardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName string
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue string
    Specifies the new HTTP header replacement value.
    regexHeaderMatch string
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace string
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName string
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName string
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName string
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoid_duplicate_headers bool
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    custom_header_name str
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    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 to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    new_header_value str
    Specifies the new HTTP header replacement value.
    regex_header_match str
    Specifies a Perl-compatible regular expression to match within the header value.
    regex_header_replace str
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standard_add_header_name str
    If the value of action is ADD, this specifies the name of the field to add.
    standard_delete_header_name str
    If the value of action is DELETE, this specifies the name of the field to remove.
    standard_modify_header_name str
    If the value of action is MODIFY or REGEX, 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 or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.
    avoidDuplicateHeaders Boolean
    When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.
    customHeaderName String
    Specifies a custom field name that applies when the relevant standard header name is set to OTHER.
    headerValue 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.
    matchMultiple Boolean
    When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.
    newHeaderValue String
    Specifies the new HTTP header replacement value.
    regexHeaderMatch String
    Specifies a Perl-compatible regular expression to match within the header value.
    regexHeaderReplace String
    Specifies text that replaces the regexHeaderMatch pattern within the header value.
    standardAddHeaderName String
    If the value of action is ADD, this specifies the name of the field to add.
    standardDeleteHeaderName String
    If the value of action is DELETE, this specifies the name of the field to remove.
    standardModifyHeaderName String
    If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorModifyViaHeader

    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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ModificationOption string
    Specify how you want to handle the header.
    RenameHeaderTo string
    Specifies a new name to replace the existing Via header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    modificationOption string
    Specify how you want to handle the header.
    renameHeaderTo string
    Specifies a new name to replace the existing Via header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_to str
    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.
    modificationOption String
    Specify how you want to handle the header.
    renameHeaderTo String
    Specifies a new name to replace the existing Via header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorOrigin

    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities List<GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthority>
    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.
    CustomCertificates List<GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificate>
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues List<string>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20240212BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities List<string>
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    CacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    Compress bool
    Enables gzip compression for non-NetStorage origins.
    CustomCertificateAuthorities []GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthority
    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.
    CustomCertificates []GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificate
    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.
    CustomForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    CustomValidCnValues []string
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    EnableTrueClientIp bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    ForwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    HttpPort int
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    HttpsPort 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. See Secure property requirements for guidance.
    IpVersion 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.
    MaxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    MinTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    Mslorigin string
    This specifies the media's origin server.
    NetStorage GetPropertyRulesBuilderRulesV20240212BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    OriginCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginCertsToHonor string
    Specifies which certificate to trust.
    OriginId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    OriginSni 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.
    OriginType 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.
    SaasCnameEnabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    SaasCnameLevel int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    SaasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    SaasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    SaasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    SaasReplace string
    Specifies replacement text for what saasRegex matches.
    SaasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    SaasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    SecondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    SecondHostnameEnabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    StandardCertificateAuthorities []string
    TemplateUuid string
    This option is for internal usage only.
    Tls13Support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    TlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TrueClientIpClientSetting bool
    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.
    TrueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    UseUniqueCacheKey bool
    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.
    VerificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities List<GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthority>
    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.
    customCertificates List<GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificate>
    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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Integer
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort 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. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20240212BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Integer
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cacheKeyHostname string
    Specifies the hostname to use when forming a cache key.
    compress boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthority[]
    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.
    customCertificates GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificate[]
    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.
    customForwardHostHeader string
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues string[]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader string
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion string
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion string
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin string
    This specifies the media's origin server.
    netStorage GetPropertyRulesBuilderRulesV20240212BehaviorOriginNetStorage
    Specifies the details of the NetStorage server.
    originCertificate string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor string
    Specifies which certificate to trust.
    originId string
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie string
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString string
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex string
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace string
    Specifies replacement text for what saasRegex matches.
    saasSuffix string
    Specifies the static part of the SaaS dynamic origin.
    saasType string
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname string
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities string[]
    templateUuid string
    This option is for internal usage only.
    tls13Support boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting boolean
    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.
    trueClientIpHeader string
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey boolean
    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.
    verificationMode string
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
    cache_key_hostname str
    Specifies the hostname to use when forming a cache key.
    compress bool
    Enables gzip compression for non-NetStorage origins.
    custom_certificate_authorities Sequence[GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthority]
    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[GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificate]
    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_host_header str
    This specifies the name of the custom host header the edge server should pass to the origin.
    custom_valid_cn_values Sequence[str]
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enable_true_client_ip bool
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forward_host_header str
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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. See Secure 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.
    max_tls_version str
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    min_tls_version str
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin str
    This specifies the media's origin server.
    net_storage GetPropertyRulesBuilderRulesV20240212BehaviorOriginNetStorage
    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_to_honor str
    Specifies which certificate to trust.
    origin_id str
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id 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.
    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_enabled bool
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saas_cname_level int
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saas_cookie str
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saas_query_string str
    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_enabled bool
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standard_certificate_authorities Sequence[str]
    template_uuid str
    This option is for internal usage only.
    tls13_support bool
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tls_version_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    true_client_ip_client_setting bool
    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_ip_header str
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    use_unique_cache_key bool
    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.
    cacheKeyHostname String
    Specifies the hostname to use when forming a cache key.
    compress Boolean
    Enables gzip compression for non-NetStorage origins.
    customCertificateAuthorities 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.
    customCertificates 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.
    customForwardHostHeader String
    This specifies the name of the custom host header the edge server should pass to the origin.
    customValidCnValues List<String>
    Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    enableTrueClientIp Boolean
    When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    forwardHostHeader String
    When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host 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.
    httpPort Number
    Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    httpsPort Number
    Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.
    ipVersion 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.
    maxTlsVersion String
    Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.
    minTlsVersion String
    Specifies the minimum TLS version to use for connections to your origin server.
    mslorigin String
    This specifies the media's origin server.
    netStorage Property Map
    Specifies the details of the NetStorage server.
    originCertificate String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originCertsToHonor String
    Specifies which certificate to trust.
    originId String
    Identifies the Edge Load Balancing origin. This needs to correspond to an edgeLoadBalancingOrigin behavior's id attribute within the same property.
    originSni Boolean
    For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information.
    originType 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.
    saasCnameEnabled Boolean
    Enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    saasCnameLevel Number
    Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    saasCookie String
    Specifies the name of the cookie that identifies this SaaS dynamic origin.
    saasQueryString String
    Specifies the name of the query parameter that identifies this SaaS dynamic origin.
    saasRegex String
    Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    saasReplace String
    Specifies replacement text for what saasRegex matches.
    saasSuffix String
    Specifies the static part of the SaaS dynamic origin.
    saasType String
    Specifies the part of the request that identifies this SaaS dynamic origin.
    secondHostname String
    Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    secondHostnameEnabled Boolean
    Available only for certain products. This specifies whether you want to use an additional origin server address.
    standardCertificateAuthorities List<String>
    templateUuid String
    This option is for internal usage only.
    tls13Support Boolean
    Enables transport layer security (TLS) version 1.3 for connections to your origin server.
    tlsVersionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    trueClientIpClientSetting Boolean
    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.
    trueClientIpHeader String
    This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.
    useUniqueCacheKey Boolean
    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.
    verificationMode String
    For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristics

    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings List<string>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    AccessKeyEncryptedStorage bool
    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.
    AdcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AuthenticationMethod string
    Specifies the authentication method.
    AuthenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AwsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    AwsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    AwsArRegion string
    AwsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    AwsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    AwsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    AwsService 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.
    CustomSignStrings []string
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    DirectConnectGeo string
    Provides a region used by Akamai Direct Connection.
    EncodingVersion int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    EndPointService string
    GcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    GcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    GcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    HostnameTag bool
    Locked bool
    Indicates 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.
    OriginLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PropertyIdTag bool
    RoleArn string
    SecretKey string
    Specifies the shared secret key.
    TemplateUuid string
    This option is for internal usage only.
    UseCustomSignString bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Integer
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.
    accessKeyEncryptedStorage boolean
    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.
    adcTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod string
    Specifies the authentication method.
    authenticationMethodTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId string
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid string
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion string
    awsHost string
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion string
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey string
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings string[]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo string
    Provides a region used by Akamai Direct Connection.
    encodingVersion number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService string
    gcsAccessKeyVersionGuid string
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId string
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret string
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag boolean
    locked boolean
    Indicates 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.
    originLocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag boolean
    roleArn string
    secretKey string
    Specifies the shared secret key.
    templateUuid string
    This option is for internal usage only.
    useCustomSignString boolean
    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_encrypted_storage bool
    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_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    aws_access_key_id str
    Specifies active access key ID linked to your AWS account.
    aws_access_key_version_guid str
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    aws_ar_region str
    aws_host str
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    aws_region str
    This specifies the AWS region code of the location where your bucket resides.
    aws_secret_access_key str
    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_strings Sequence[str]
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    direct_connect_geo str
    Provides a region used by Akamai Direct Connection.
    encoding_version int
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    end_point_service str
    gcs_access_key_version_guid str
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcs_hmac_key_access_id str
    Specifies the active access ID linked to your Google account.
    gcs_hmac_key_secret str
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostname_tag bool
    locked bool
    Indicates 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.
    origin_location_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    property_id_tag bool
    role_arn str
    secret_key str
    Specifies the shared secret key.
    template_uuid str
    This option is for internal usage only.
    use_custom_sign_string bool
    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.
    accessKeyEncryptedStorage Boolean
    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.
    adcTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    authenticationMethod String
    Specifies the authentication method.
    authenticationMethodTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    awsAccessKeyId String
    Specifies active access key ID linked to your AWS account.
    awsAccessKeyVersionGuid String
    Identifies the unique awsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to AWS S3.
    awsArRegion String
    awsHost String
    This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
    awsRegion String
    This specifies the AWS region code of the location where your bucket resides.
    awsSecretAccessKey String
    Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
    awsService 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.
    customSignStrings List<String>
    Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.
    directConnectGeo String
    Provides a region used by Akamai Direct Connection.
    encodingVersion Number
    Specifies the version of the encryption algorithm, an integer from 1 to 5.
    endPointService String
    gcsAccessKeyVersionGuid String
    Identifies the unique gcsAccessKeyVersionGuid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
    gcsHmacKeyAccessId String
    Specifies the active access ID linked to your Google account.
    gcsHmacKeySecret String
    Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
    hostnameTag Boolean
    locked Boolean
    Indicates 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.
    originLocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    propertyIdTag Boolean
    roleArn String
    secretKey String
    Specifies the shared secret key.
    templateUuid String
    This option is for internal usage only.
    useCustomSignString Boolean
    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.

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCharacteristicsWsd

    Locked bool
    Indicates 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificate

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthority

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthorityIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateAuthoritySubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateIssuerRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginCustomCertificateSubjectRdns

    C string
    Cn string
    O string
    Ou string
    C string
    Cn string
    O string
    Ou string
    c String
    cn String
    o String
    ou String
    c string
    cn string
    o string
    ou string
    c str
    cn str
    o str
    ou str
    c String
    cn String
    o String
    ou String

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryMethod

    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CustomStatusCode string
    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.
    RecoveryMethod string
    Specifies the recovery method.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    customStatusCode string
    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.
    recoveryMethod string
    Specifies the recovery method.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_code str
    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.
    customStatusCode String
    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.
    recoveryMethod String
    Specifies the recovery method.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginFailureRecoveryPolicy

    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s List<string>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    BinaryEquivalentContent bool
    Synchronizes content between the primary and backup origins, byte for byte.
    EnableIpAvoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    Enabled bool
    Activates and configures a recovery policy.
    IpAvoidanceErrorThreshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    IpAvoidanceRetryInterval int
    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.
    MonitorOriginResponsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    MonitorResponseCodes1s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes2s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    MonitorResponseCodes3s []string
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    MonitorStatusCodes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes1EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes1EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes2EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes2EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    MonitorStatusCodes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    MonitorStatusCodes3EnableRecovery bool
    Enables the recovery action for the response codes you define.
    MonitorStatusCodes3EnableRetry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    MonitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessCustomTimeout int
    Specify a custom timeout, from 1 to 10 seconds.
    OriginResponsivenessEnableRecovery bool
    Enables a recovery action for a specific failure condition.
    OriginResponsivenessEnableRetry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    OriginResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    OriginResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    OriginResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    StatusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    StatusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TuningParameters 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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Integer
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Integer
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Integer
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.
    binaryEquivalentContent boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval number
    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.
    monitorOriginResponsiveness boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s string[]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName string
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout string
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    tuningParameters 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_content bool
    Synchronizes content between the primary and backup origins, byte for byte.
    enable_ip_avoidance bool
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled bool
    Activates and configures a recovery policy.
    ip_avoidance_error_threshold int
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ip_avoidance_retry_interval int
    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_responsiveness bool
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitor_response_codes1s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes2s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitor_response_codes3s Sequence[str]
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitor_status_codes1 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes1_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes1_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes1_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes2 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes2_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes2_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes2_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitor_status_codes3 bool
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitor_status_codes3_enable_recovery bool
    Enables the recovery action for the response codes you define.
    monitor_status_codes3_enable_retry bool
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitor_status_codes3_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_custom_timeout int
    Specify a custom timeout, from 1 to 10 seconds.
    origin_responsiveness_enable_recovery bool
    Enables a recovery action for a specific failure condition.
    origin_responsiveness_enable_retry bool
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    origin_responsiveness_monitoring str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    origin_responsiveness_recovery_config_name str
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    origin_responsiveness_timeout str
    The timeout threshold that triggers a retry or recovery action.
    status_code_monitoring1 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring2 str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    status_code_monitoring3 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.
    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.
    binaryEquivalentContent Boolean
    Synchronizes content between the primary and backup origins, byte for byte.
    enableIpAvoidance Boolean
    Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the configName established for originResponsivenessRecoveryConfigName is applied.
    enabled Boolean
    Activates and configures a recovery policy.
    ipAvoidanceErrorThreshold Number
    Defines the number of failures that need to occur to an origin address before it's blocked.
    ipAvoidanceRetryInterval Number
    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.
    monitorOriginResponsiveness Boolean
    Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
    monitorResponseCodes1s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes2s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
    monitorResponseCodes3s List<String>
    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 other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
    monitorStatusCodes1 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes1EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes1EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes1RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes2 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes2EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes2EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes2RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    monitorStatusCodes3 Boolean
    Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
    monitorStatusCodes3EnableRecovery Boolean
    Enables the recovery action for the response codes you define.
    monitorStatusCodes3EnableRetry Boolean
    When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
    monitorStatusCodes3RecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessCustomTimeout Number
    Specify a custom timeout, from 1 to 10 seconds.
    originResponsivenessEnableRecovery Boolean
    Enables a recovery action for a specific failure condition.
    originResponsivenessEnableRetry Boolean
    If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
    originResponsivenessMonitoring String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    originResponsivenessRecoveryConfigName String
    Specifies a recovery configuration using the configName you defined in the recoveryConfig match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recoveryConfig match criteria to apply this option.
    originResponsivenessTimeout String
    The timeout threshold that triggers a retry or recovery action.
    statusCodeMonitoring1 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring2 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    statusCodeMonitoring3 String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    tuningParameters 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginIpAcl

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorOriginNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240212BehaviorPermissionsPolicy

    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives List<string>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PermissionsPolicyDirectives []string
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowList string
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives string[]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_list str
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissions_policy_directives Sequence[str]
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    allowList String
    The features you've set in permissionsPolicyDirective are enabled for domains you specify here. They'll remain disabled for all other domains. Separate multiple domains with a single space. To block the specified directives from all domains, set this to none. This generates an empty value in the Permissions-Policy header.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    permissionsPolicyDirectives List<String>
    Each directive represents a browser feature. Specify the ones you want enabled in a client browser that accesses your content. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPersistentClientConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorPersistentConnection

    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.
    TemplateUuid 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.
    TemplateUuid 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.
    templateUuid 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.
    templateUuid 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.
    templateUuid 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorPersonallyIdentifiableInformation

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPhasedRelease

    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes List<string>
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    Enabled bool
    Enables the Phased Release Cloudlet.
    FailoverDuration 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.
    FailoverEnabled bool
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    FailoverResponseCodes []string
    Defines the set of failure codes that initiate the failover response.
    FailoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    IsSharedPolicy 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.
    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.
    PopulationCookieType 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 effectively NONE.
    PopulationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    PopulationExpirationDate string
    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.
    PopulationRefresh bool
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    PopulationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes string[]
    Defines the set of failure codes that initiate the failover response.
    failoverTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration string
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate string
    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.
    populationRefresh boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212BehaviorPhasedReleaseCloudletPolicy
    Specifies the Cloudlet policy as an object.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    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_codes Sequence[str]
    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.
    is_shared_policy 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.
    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.
    population_cookie_type 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 effectively NONE.
    population_duration str
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    population_expiration_date str
    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.
    cloudletPolicy Property Map
    Specifies the Cloudlet policy as an object.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enabled Boolean
    Enables the Phased Release Cloudlet.
    failoverDuration 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.
    failoverEnabled Boolean
    Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
    failoverResponseCodes List<String>
    Defines the set of failure codes that initiate the failover response.
    failoverTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    isSharedPolicy 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.
    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.
    populationCookieType 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 effectively NONE.
    populationDuration String
    Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
    populationExpirationDate String
    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.
    populationRefresh Boolean
    Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
    populationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPhasedReleaseCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorPreconnect

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Preconnectlists List<string>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Preconnectlists []string
    Specifies the set of hostnames to which to preconnect over HTTP2.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists string[]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    preconnectlists Sequence[str]
    Specifies the set of hostnames to which to preconnect over HTTP2.
    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.
    preconnectlists List<String>
    Specifies the set of hostnames to which to preconnect over HTTP2.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPredictiveContentDelivery

    Enabled bool
    Enables the predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 predictive content delivery 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 predictive content delivery 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPredictivePrefetching

    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AccuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    Enabled bool
    Enables the predictive prefetching 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracyTarget string
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled boolean
    Enables the predictive prefetching 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accuracy_target str
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled bool
    Enables the predictive prefetching 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.
    accuracyTarget String
    The level of prefetching. A higher level results in better client performance, but potentially greater load on the origin.
    enabled Boolean
    Enables the predictive prefetching 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPrefetch

    Enabled bool
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Applies prefetching behavior 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.
    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
    Applies prefetching behavior 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPrefetchable

    Enabled bool
    Allows matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 matching content to prefetch when referenced on a requested parent page.
    locked bool
    Indicates that your 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 matching content to prefetch when referenced on a requested parent page.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorPrefreshCache

    Enabled bool
    Enables the cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    Prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval Integer
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 cache prefreshing 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.
    prefreshval int
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    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 cache prefreshing 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.
    prefreshval Number
    Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorQuality

    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AudienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CatalogSize string
    ContentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ContentType string
    Country string
    DeliveryFormat string
    DeliveryType string
    DownloadType string
    EndUserLocation 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.
    MaximumConcurrentUsers string
    ObjectSize string
    OptimizeFor string
    OriginSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PopularityDistribution string
    RefreshRate string
    SegmentDuration int
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Integer
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audienceSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize string
    contentSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType string
    country string
    deliveryFormat string
    deliveryType string
    downloadType string
    endUserLocation 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.
    maximumConcurrentUsers string
    objectSize string
    optimizeFor string
    originSettings string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution string
    refreshRate string
    segmentDuration number
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    audience_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalog_size str
    content_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    content_type str
    country str
    delivery_format str
    delivery_type str
    download_type str
    end_user_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.
    maximum_concurrent_users str
    object_size str
    optimize_for str
    origin_settings str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularity_distribution str
    refresh_rate str
    segment_duration int
    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.
    audienceSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    catalogSize String
    contentSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    contentType String
    country String
    deliveryFormat String
    deliveryType String
    downloadType String
    endUserLocation 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.
    maximumConcurrentUsers String
    objectSize String
    optimizeFor String
    originSettings String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    popularityDistribution String
    refreshRate String
    segmentDuration Number
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorQuicBeta

    Enabled bool
    Enables QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QuicOfferPercentage int
    The percentage of responses for which to allow QUIC sessions.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Integer
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 QUIC support.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quic_offer_percentage int
    The percentage of responses for which to allow QUIC sessions.
    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 QUIC support.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    quicOfferPercentage Number
    The percentage of responses for which to allow QUIC sessions.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRandomSeek

    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Flv bool
    Enables random seek optimization in FLV files.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    Mp4 bool
    Enables random seek optimization in MP4 files.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv boolean
    Enables random seek optimization in FLV files.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize string
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 boolean
    Enables random seek optimization in MP4 files.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    flv bool
    Enables random seek optimization in FLV files.
    locked bool
    Indicates 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
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 bool
    Enables random seek optimization in MP4 files.
    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.
    flv Boolean
    Enables random seek optimization in FLV files.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    maximumSize String
    Sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.
    mp4 Boolean
    Enables random seek optimization in MP4 files.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRapid

    Enabled bool
    Enables API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 API Gateway for the current set 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.
    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 API Gateway for the current set 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorReadTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked bool
    Indicates that your 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 read timeout necessary before failing with a 504 error. This value should never be zero.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 read timeout necessary before failing with a 504 error. This value should never be zero.

    GetPropertyRulesBuilderRulesV20240212BehaviorRealTimeReporting

    Advanced bool
    Enables advanced options.
    BeaconSamplingPercentage double
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    BeaconSamplingPercentage float64
    Specifies the percentage for sampling.
    Enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage Double
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beaconSamplingPercentage number
    Specifies the percentage for sampling.
    enabled boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Enables advanced options.
    beacon_sampling_percentage float
    Specifies the percentage for sampling.
    enabled bool
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked bool
    Indicates that your 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.
    advanced Boolean
    Enables advanced options.
    beaconSamplingPercentage Number
    Specifies the percentage for sampling.
    enabled Boolean
    Enables reports on delivery of cloud hosted content at near real-time latencies.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRealUserMonitoring

    Enabled bool
    When enabled, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates real-use monitoring.
    locked bool
    Indicates that your 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, activates real-use monitoring.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRedirect

    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    DestinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    DestinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    DestinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    DestinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    DestinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    DestinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    DestinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    DestinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    DestinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    DestinationProtocol string
    Choose the protocol for the redirect URL.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    QueryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    ResponseCode int
    Specify the redirect's response code.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Integer
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destinationHostname string
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther string
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling string
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain string
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath string
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther string
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix string
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix string
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus string
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol string
    Choose the protocol for the redirect URL.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice string
    Either specify a default response for mobile browsers, or customize your own.
    queryString string
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode number
    Specify the redirect's response code.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination_hostname str
    Specify how to change the requested hostname, independently from the pathname.
    destination_hostname_other str
    Specifies the full hostname with which to replace the current hostname.
    destination_hostname_sibling str
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destination_hostname_subdomain str
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destination_path str
    Specify how to change the requested pathname, independently from the hostname.
    destination_path_other str
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destination_path_prefix str
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destination_path_suffix str
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destination_path_suffix_status str
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destination_protocol str
    Choose the protocol for the redirect URL.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobile_default_choice str
    Either specify a default response for mobile browsers, or customize your own.
    query_string str
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    response_code int
    Specify the redirect's 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.
    destinationHostname String
    Specify how to change the requested hostname, independently from the pathname.
    destinationHostnameOther String
    Specifies the full hostname with which to replace the current hostname.
    destinationHostnameSibling String
    Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.
    destinationHostnameSubdomain String
    Specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.
    destinationPath String
    Specify how to change the requested pathname, independently from the hostname.
    destinationPathOther String
    When destinationPath is set to PREFIX_REQUEST, this replaces the current path.
    destinationPathPrefix String
    When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.
    destinationPathSuffix String
    When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.
    destinationPathSuffixStatus String
    When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix.
    destinationProtocol String
    Choose the protocol for the redirect URL.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mobileDefaultChoice String
    Either specify a default response for mobile browsers, or customize your own.
    queryString String
    When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.
    responseCode Number
    Specify the redirect's response code.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRedirectplus

    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    Enabled bool
    Enables the redirect 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.
    ResponseCode int
    Assigns the status code for the redirect response.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Integer
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination string
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled boolean
    Enables the redirect 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.
    responseCode number
    Assigns the status code for the redirect response.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    destination str
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled bool
    Enables the redirect 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.
    response_code int
    Assigns the status code for the redirect 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.
    destination String
    Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request's filename: /path/to/{{builtin.AK_FILENAME}}.
    enabled Boolean
    Enables the redirect 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.
    responseCode Number
    Assigns the status code for the redirect response.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRefererChecking

    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains List<string>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowChildren bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    Domains []string
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    Enabled bool
    Enables the referer-checking 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.
    Strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowChildren boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains string[]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled boolean
    Enables the referer-checking 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.
    strict boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_children bool
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains Sequence[str]
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled bool
    Enables the referer-checking 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.
    strict bool
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    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.
    allowChildren Boolean
    Allows all subdomains for the domains set, just like adding a *. prefix to each.
    domains List<String>
    Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.
    enabled Boolean
    Enables the referer-checking 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.
    strict Boolean
    When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRemoveQueryParameter

    Locked bool
    Indicates 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 parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Parameters []string
    Specifies parameters to remove from the request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters List<String>
    Specifies parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters string[]
    Specifies parameters to remove from the request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    parameters Sequence[str]
    Specifies parameters to remove from 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.
    locked Boolean
    Indicates 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 parameters to remove from the request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRemoveVary

    Enabled bool
    When enabled, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, removes the Vary header to ensure objects can be cached.
    locked bool
    Indicates that your 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, removes the Vary header to ensure objects can be cached.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorReport

    Cookies List<string>
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Cookies []string
    This specifies the set of cookies names whose values you want to log.
    CustomLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LogAcceptLanguage bool
    Log the Accept-Language header.
    LogCookies string
    Specifies the set of cookies to log.
    LogCustomLogField bool
    Whether to append additional custom data to each log line.
    LogEdgeIp bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    LogHost bool
    Log the Host header.
    LogReferer bool
    Log the Referer header.
    LogUserAgent bool
    Log the User-Agent header.
    LogXForwardedFor bool
    Log any X-Forwarded-For request header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies string[]
    This specifies the set of cookies names whose values you want to log.
    customLogField string
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage boolean
    Log the Accept-Language header.
    logCookies string
    Specifies the set of cookies to log.
    logCustomLogField boolean
    Whether to append additional custom data to each log line.
    logEdgeIp boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost boolean
    Log the Host header.
    logReferer boolean
    Log the Referer header.
    logUserAgent boolean
    Log the User-Agent header.
    logXForwardedFor boolean
    Log any X-Forwarded-For request header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    cookies Sequence[str]
    This specifies the set of cookies names whose values you want to log.
    custom_log_field str
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked bool
    Indicates 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_accept_language bool
    Log the Accept-Language header.
    log_cookies str
    Specifies the set of cookies to log.
    log_custom_log_field bool
    Whether to append additional custom data to each log line.
    log_edge_ip bool
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    log_host bool
    Log the Host header.
    log_referer bool
    Log the Referer header.
    log_user_agent bool
    Log the User-Agent header.
    log_x_forwarded_for bool
    Log any X-Forwarded-For request 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.
    cookies List<String>
    This specifies the set of cookies names whose values you want to log.
    customLogField String
    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. See Support for variables for more information. If you enable the logCustom behavior, it overrides the customLogField option.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    logAcceptLanguage Boolean
    Log the Accept-Language header.
    logCookies String
    Specifies the set of cookies to log.
    logCustomLogField Boolean
    Whether to append additional custom data to each log line.
    logEdgeIp Boolean
    Whether to log the IP address of the Akamai edge server that served the response to the client.
    logHost Boolean
    Log the Host header.
    logReferer Boolean
    Log the Referer header.
    logUserAgent Boolean
    Log the User-Agent header.
    logXForwardedFor Boolean
    Log any X-Forwarded-For request header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRequestClientHints

    AcceptChes List<string>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes List<string>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AcceptChes []string
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    AcceptCriticalChes []string
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    Reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acceptChes string[]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes string[]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    accept_ches Sequence[str]
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    accept_critical_ches Sequence[str]
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset bool
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your 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.
    acceptChes List<String>
    The client hint data objects you want to receive from the browser. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this behavior. If you've configured your origin server to pass along data objects, they merge with the ones you set in this array, before the list is sent to the client.
    acceptCriticalChes List<String>
    The critical client hint data objects you want to receive from the browser. The original request from the browser needs to include these objects. Otherwise, a new response header is sent back to the client, asking for all of these client hint data objects. You can add custom entries or provide pre-set values from the list. For more details on each value, see the guide section for this 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.
    reset Boolean
    This sends an empty instance of the Accept-CH response header to clear other Accept-CH values currently stored in the client browser. This empty header doesn't get merged with other objects sent from your origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRequestControl

    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    Branded403StatusCode int
    Specifies the response status code for the branded deny action.
    Branded403Url string
    Specifies the redirect URL for the branded deny action.
    BrandedDenyCacheTtl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    CloudletSharedPolicy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    EnableBranded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    Enabled bool
    Enables the Request Control Cloudlet.
    IsSharedPolicy 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.
    NetStorage GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Integer
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Integer
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Integer
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403File string
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode number
    Specifies the response status code for the branded deny action.
    branded403Url string
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudletSharedPolicy number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    branded403_file str
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403_status_code int
    Specifies the response status code for the branded deny action.
    branded403_url str
    Specifies the redirect URL for the branded deny action.
    branded_deny_cache_ttl int
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlCloudletPolicy
    Identifies the Cloudlet policy.
    cloudlet_shared_policy int
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enable_branded403 bool
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled bool
    Enables the Request Control Cloudlet.
    is_shared_policy 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.
    net_storage GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlNetStorage
    Specifies the NetStorage domain that contains the branded 403 page.
    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.
    branded403File String
    Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.
    branded403StatusCode Number
    Specifies the response status code for the branded deny action.
    branded403Url String
    Specifies the redirect URL for the branded deny action.
    brandedDenyCacheTtl Number
    Specifies the branded response page's time to live in the cache, 5 minutes by default.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    cloudletSharedPolicy Number
    Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
    enableBranded403 Boolean
    If enabled, serves a branded 403 page for this Cloudlet instance.
    enabled Boolean
    Enables the Request Control Cloudlet.
    isSharedPolicy 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.
    netStorage Property Map
    Specifies the NetStorage domain that contains the branded 403 page.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorRequestControlNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240212BehaviorRequestTypeMarker

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RequestType string
    Specifies the type of request.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    requestType string
    Specifies the type of request.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    request_type str
    Specifies the type of 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    requestType String
    Specifies the type of request.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizer

    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Resource Optimizer 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 Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorResourceOptimizerExtendedCompatibility

    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableAllFeatures bool
    Enables additional support and error handling.
    Enabled bool
    Enables the Resource Optimizer 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableAllFeatures boolean
    Enables additional support and error handling.
    enabled boolean
    Enables the Resource Optimizer 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_all_features bool
    Enables additional support and error handling.
    enabled bool
    Enables the Resource Optimizer 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.
    enableAllFeatures Boolean
    Enables additional support and error handling.
    enabled Boolean
    Enables the Resource Optimizer 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    StatusCode int
    The HTTP status code to replace the existing one.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Integer
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode number
    The HTTP status code to replace the existing one.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    override206 bool
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    status_code int
    The HTTP status code to replace the existing one.
    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.
    override206 Boolean
    Allows any specified 200 success code to override a 206 partial-content code, in which case the response's content length matches the requested range length.
    statusCode Number
    The HTTP status code to replace the existing one.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorResponseCookie

    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    CookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    DefaultDomain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    DefaultPath bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    Domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    Duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    Enabled bool
    Allows you to set a response cookie.
    ExpirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    Expires string
    Sets various ways to specify when the cookie expires.
    Format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    HttpOnly bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    Path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    SameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    Secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    TemplateUuid string
    This option is for internal usage only.
    Type string
    What type of value to assign.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName string
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain string
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration string
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled boolean
    Allows you to set a response cookie.
    expirationDate string
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires string
    Sets various ways to specify when the cookie expires.
    format string
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path string
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite string
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid string
    This option is for internal usage only.
    type string
    What type of value to assign.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.
    cookie_name str
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    default_domain bool
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    default_path bool
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain str
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration str
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled bool
    Allows you to set a response cookie.
    expiration_date str
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires str
    Sets various ways to specify when the cookie expires.
    format str
    When the type of cookie is set to UNIQUE, this sets the date format.
    http_only bool
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path str
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    same_site str
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure bool
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    template_uuid str
    This option is for internal usage only.
    type str
    What type of value to assign.
    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
    If the cookie type is FIXED, this specifies the cookie value.
    cookieName String
    Specifies the name of the cookie, which serves as a key to determine if the cookie is set.
    defaultDomain Boolean
    When enabled, uses the default domain value, otherwise the set specified in the domain field.
    defaultPath Boolean
    When enabled, uses the default path value, otherwise the set specified in the path field.
    domain String
    If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.
    duration String
    If expires is set to DURATION, this sets the cookie's lifetime.
    enabled Boolean
    Allows you to set a response cookie.
    expirationDate String
    If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.
    expires String
    Sets various ways to specify when the cookie expires.
    format String
    When the type of cookie is set to UNIQUE, this sets the date format.
    httpOnly Boolean
    When enabled, includes the HttpOnly attribute in the Set-Cookie response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports 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.
    path String
    If the defaultPath is disabled, sets the path component for which the cookie is valid.
    sameSite String
    This option controls the SameSite cookie attribute that reduces the risk of cross-site request forgery attacks.
    secure Boolean
    When enabled, sets the cookie's Secure flag to transmit it with HTTPS.
    templateUuid String
    This option is for internal usage only.
    type String
    What type of value to assign.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    If the cookie type is FIXED, this specifies the cookie value.

    GetPropertyRulesBuilderRulesV20240212BehaviorRestrictObjectCaching

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MaximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    maximumSize string
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_size str
    Specifies a fixed maximum size of non-HTML content to cache.
    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.
    maximumSize String
    Specifies a fixed maximum size of non-HTML content to cache.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorReturnCacheStatus

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    ResponseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    responseHeaderName string
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    response_header_name str
    Specifies the name of the HTTP header in which to report the cache status 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.
    responseHeaderName String
    Specifies the name of the HTTP header in which to report the cache status value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRewriteUrl

    Behavior string
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    KeepQueryString bool
    When enabled, retains the original path's query parameters.
    Locked bool
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    MatchMultiple bool
    When enabled, replaces all potential matches rather than only the first.
    MatchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    TargetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    TargetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    TargetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    TargetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keepQueryString boolean
    When enabled, retains the original path's query parameters.
    locked boolean
    Indicates 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 string
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex string
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath string
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend string
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex string
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl string
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The action to perform on the path.
    keep_query_string bool
    When enabled, retains the original path's query parameters.
    locked bool
    Indicates 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 str
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    match_multiple bool
    When enabled, replaces all potential matches rather than only the first.
    match_regex str
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    target_path str
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    target_path_prepend str
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    target_regex str
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    target_url str
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    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
    The action to perform on the path.
    keepQueryString Boolean
    When enabled, retains the original path's query parameters.
    locked Boolean
    Indicates 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 String
    When behavior is REMOVE or REPLACE, specifies the part of the incoming path you'd like to remove or modify.
    matchMultiple Boolean
    When enabled, replaces all potential matches rather than only the first.
    matchRegex String
    When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.
    targetPath String
    When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request's path.
    targetPathPrepend String
    When behavior is set to PREPEND, specifies a path to prepend to the incoming request's URL.
    targetRegex String
    When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.
    targetUrl String
    When behavior is set to REWRITE, specifies the full path to request from the origin.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorRumCustom

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    RumSampleRate int
    Specifies the percentage of web traffic to include in your RUM report.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Integer
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rumGroupName string
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    rum_group_name str
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rum_sample_rate int
    Specifies the percentage of web traffic to include in your RUM 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.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    rumGroupName String
    A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.
    rumSampleRate Number
    Specifies the percentage of web traffic to include in your RUM report.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSaasDefinitions

    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    ApplicationAction string
    Specifies the request component that identifies a SaaS application.
    ApplicationCnameEnabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    ApplicationCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    ApplicationCookie string
    This specifies the name of the cookie that identifies the application.
    ApplicationQueryString string
    This names the query parameter that identifies the application.
    ApplicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    ApplicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    ApplicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomerAction string
    Specifies the request component that identifies a SaaS customer.
    CustomerCnameEnabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    CustomerCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    CustomerCookie string
    This specifies the name of the cookie that identifies the customer.
    CustomerQueryString string
    This names the query parameter that identifies the customer.
    CustomerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    CustomerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    CustomerTitle 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.
    TemplateUuid string
    This option is for internal usage only.
    UsersAction string
    Specifies the request component that identifies a SaaS user.
    UsersCnameEnabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    UsersCnameLevel int
    Specifies the number of CNAMEs to use in the chain.
    UsersCookie string
    This specifies the name of the cookie that identifies the user.
    UsersQueryString string
    This names the query parameter that identifies the user.
    UsersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    UsersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    UsersTitle 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Integer
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    applicationAction string
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie string
    This specifies the name of the cookie that identifies the application.
    applicationQueryString string
    This names the query parameter that identifies the application.
    applicationRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace string
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction string
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie string
    This specifies the name of the cookie that identifies the customer.
    customerQueryString string
    This names the query parameter that identifies the customer.
    customerRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace string
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid string
    This option is for internal usage only.
    usersAction string
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie string
    This specifies the name of the cookie that identifies the user.
    usersQueryString string
    This names the query parameter that identifies the user.
    usersRegex string
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace string
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.
    application_action str
    Specifies the request component that identifies a SaaS application.
    application_cname_enabled bool
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    application_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    application_cookie str
    This specifies the name of the cookie that identifies the application.
    application_query_string str
    This names the query parameter that identifies the application.
    application_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    application_replace str
    Specifies a string to replace the request's application ID matched by applicationRegex.
    application_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customer_action str
    Specifies the request component that identifies a SaaS customer.
    customer_cname_enabled bool
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customer_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    customer_cookie str
    This specifies the name of the cookie that identifies the customer.
    customer_query_string str
    This names the query parameter that identifies the customer.
    customer_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customer_replace str
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customer_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.
    users_action str
    Specifies the request component that identifies a SaaS user.
    users_cname_enabled bool
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    users_cname_level int
    Specifies the number of CNAMEs to use in the chain.
    users_cookie str
    This specifies the name of the cookie that identifies the user.
    users_query_string str
    This names the query parameter that identifies the user.
    users_regex str
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    users_replace str
    Specifies a string to replace the request's user ID matched by usersRegex.
    users_title 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.
    applicationAction String
    Specifies the request component that identifies a SaaS application.
    applicationCnameEnabled Boolean
    Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
    applicationCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    applicationCookie String
    This specifies the name of the cookie that identifies the application.
    applicationQueryString String
    This names the query parameter that identifies the application.
    applicationRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
    applicationReplace String
    Specifies a string to replace the request's application ID matched by applicationRegex.
    applicationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customerAction String
    Specifies the request component that identifies a SaaS customer.
    customerCnameEnabled Boolean
    Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
    customerCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    customerCookie String
    This specifies the name of the cookie that identifies the customer.
    customerQueryString String
    This names the query parameter that identifies the customer.
    customerRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
    customerReplace String
    Specifies a string to replace the request's customer ID matched by customerRegex.
    customerTitle 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.
    templateUuid String
    This option is for internal usage only.
    usersAction String
    Specifies the request component that identifies a SaaS user.
    usersCnameEnabled Boolean
    Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
    usersCnameLevel Number
    Specifies the number of CNAMEs to use in the chain.
    usersCookie String
    This specifies the name of the cookie that identifies the user.
    usersQueryString String
    This names the query parameter that identifies the user.
    usersRegex String
    Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
    usersReplace String
    Specifies a string to replace the request's user ID matched by usersRegex.
    usersTitle 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudClient

    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowOverrideOriginCacheKey bool
    When enabled, overrides the forwarding origin's cache key.
    ConnectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    Enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginHostHeader string
    Specifies where the Host header is defined.
    OriginType string
    Specifies where the origin is.
    Sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    Sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowOverrideOriginCacheKey boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId string
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader string
    Specifies where the Host header is defined.
    originType string
    Specifies where the origin is.
    sf3cOriginHost string
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader string
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_override_origin_cache_key bool
    When enabled, overrides the forwarding origin's cache key.
    connector_id str
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled bool
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked bool
    Indicates 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_host_header str
    Specifies where the Host header is defined.
    origin_type str
    Specifies where the origin is.
    sf3c_origin_host str
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3c_origin_host_header str
    This specifies the hostname or IP address of the custom Salesforce host 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.
    allowOverrideOriginCacheKey Boolean
    When enabled, overrides the forwarding origin's cache key.
    connectorId String
    An ID value that helps distinguish different types of traffic sent from Akamai to the Salesforce Commerce Cloud. Form the value as instance-realm-customer, where instance is either production or development, realm is your Salesforce Commerce Cloud service $REALM value, and customer is the name for your organization in Salesforce Commerce Cloud. You can use alphanumeric characters, underscores, or dot characters within dash-delimited segment values.
    enabled Boolean
    Enables the Akamai Connector for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    originHostHeader String
    Specifies where the Host header is defined.
    originType String
    Specifies where the origin is.
    sf3cOriginHost String
    This specifies the hostname or IP address of the custom Salesforce origin.
    sf3cOriginHostHeader String
    This specifies the hostname or IP address of the custom Salesforce host header.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProvider

    Enabled bool
    Enables Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Akamai Provider for Salesforce Commerce Cloud.
    locked bool
    Indicates that your 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 Akamai Provider for Salesforce Commerce Cloud.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSalesForceCommerceCloudProviderHostHeader

    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    HostHeaderSource string
    Specify where the host header derives 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    hostHeaderSource string
    Specify where the host header derives 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    host_header_source str
    Specify where the host header derives 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.
    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.
    hostHeaderSource String
    Specify where the host header derives 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSavePostDcaProcessing

    Enabled bool
    Enables processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 processing of 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.
    enabled Boolean
    Enables processing of 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorScheduleInvalidation

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    RefreshMethod string
    Specifies how to invalidate the content.
    Repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    RepeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    Start string
    The UTC date and time when matching cached content is to expire.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refreshMethod string
    Specifies how to invalidate the content.
    repeat boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval string
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start string
    The UTC date and time when matching cached content is to expire.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    refresh_method str
    Specifies how to invalidate the content.
    repeat bool
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeat_interval str
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start str
    The UTC date and time when matching cached content is to expire.
    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.
    refreshMethod String
    Specifies how to invalidate the content.
    repeat Boolean
    When enabled, invalidation recurs periodically from the start time based on the repeatInterval time.
    repeatInterval String
    Specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
    start String
    The UTC date and time when matching cached content is to expire.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorScriptManagement

    Enabled bool
    Enables the Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    Serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    TemplateUuid string
    This option is for internal usage only.
    Timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Integer
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker string
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid string
    This option is for internal usage only.
    timestamp number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 Script Management 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.
    serviceworker str
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    template_uuid str
    This option is for internal usage only.
    timestamp int
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    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 Script Management 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.
    serviceworker String
    Script Management uses a JavaScript service worker called akam-sw.js. It applies a policy that helps you manage scripts.
    templateUuid String
    This option is for internal usage only.
    timestamp Number
    A read-only epoch timestamp that represents the last time a Script Management policy was synchronized with its Ion property.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedContentProtection

    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts List<string>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles List<string>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    DashMediaEncryption bool
    Whether to enable DASH Media Encryption.
    DataPayload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    EnableTokenInUri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    Enabled bool
    Enables the segmented content protection behavior.
    FieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    HeaderForSalts []string
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    HlsMasterManifestFiles []string
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    HlsMediaEncryption bool
    Enables HLS Segment Encryption.
    Ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    Key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    RevokedListId int
    Identifies the TokenAuth tokens to block from accessing your content.
    Salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    SessionId bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TokenRevocationEnabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    TokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TransitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    UseAdvanced bool
    Allows you to specify advanced transitionKey and salt options.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Integer
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption boolean
    Whether to enable DASH Media Encryption.
    dataPayload boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled boolean
    Enables the segmented content protection behavior.
    fieldCarryOver string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts string[]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles string[]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption boolean
    Enables HLS Segment Encryption.
    ip boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key string
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt string
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid string
    This option is for internal usage only.
    tokenAuthHlsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey string
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    acl bool
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dash_media_encryption bool
    Whether to enable DASH Media Encryption.
    data_payload bool
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enable_token_in_uri bool
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled bool
    Enables the segmented content protection behavior.
    field_carry_over str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    header_for_salts Sequence[str]
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hls_master_manifest_files Sequence[str]
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hls_media_encryption bool
    Enables HLS Segment Encryption.
    ip bool
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key str
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked bool
    Indicates 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_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revoked_list_id int
    Identifies the TokenAuth tokens to block from accessing your content.
    salt str
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    session_id bool
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    template_uuid str
    This option is for internal usage only.
    token_auth_hls_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_authentication_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    token_revocation_enabled bool
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    token_revocation_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transition_key str
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    use_advanced bool
    Allows you to specify advanced transitionKey and salt options.
    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.
    acl Boolean
    Enabling this option carries the ACL field from the access token over to the session token, to limit the requesting client's access to the specific URL or path set in the ACL field. Playback may fail if the base path of the master playlist (and variant playlist, plus segments) varies from that of the ACL field.
    dashMediaEncryption Boolean
    Whether to enable DASH Media Encryption.
    dataPayload Boolean
    Enabling this option carries the data/payload field from the access token over to the session token, allowing access to opaque data for log analysis for a URL protected by a session token.
    enableTokenInUri Boolean
    When enabled, passes tokens in HLS variant manifest URLs and HLS segment URLs, as an alternative to cookies.
    enabled Boolean
    Enables the segmented content protection behavior.
    fieldCarryOver String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    headerForSalts List<String>
    This allows you to include additional salt properties specific to each end user to strengthen the relationship between the session token and playback session. This specifies the set of request headers whose values generate the salt value, typically User-Agent, X-Playback-Session-Id, and Origin. Any specified header needs to appear in the player's request.
    hlsMasterManifestFiles List<String>
    Specifies the set of filenames that form HLS master manifest URLs. You can use * wildcard character that matches zero or more characters. Make sure to specify master manifest filenames uniquely, to distinguish them from variant manifest files.
    hlsMediaEncryption Boolean
    Enables HLS Segment Encryption.
    ip Boolean
    Enabling this restricts content access to a specific IP address, only appropriate if it does not change during the playback session.
    key String
    Specifies the encryption key to use as a shared secret to validate tokens.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    mediaEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    revokedListId Number
    Identifies the TokenAuth tokens to block from accessing your content.
    salt String
    Specifies a salt as input into the token for added security. This value needs to match the salt used in the token generation code.
    sessionId Boolean
    Enabling this option carries the session_id value from the access token over to the session token, for use in tracking and counting unique playback sessions.
    templateUuid String
    This option is for internal usage only.
    tokenAuthHlsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenAuthenticationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    tokenRevocationEnabled Boolean
    Enable this to deny requests from playback URLs that contain a TokenAuth token that uses specific token identifiers.
    tokenRevocationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    transitionKey String
    An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.
    useAdvanced Boolean
    Allows you to specify advanced transitionKey and salt options.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaOptimization

    Behavior string
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    DvrType string
    The type of DVR.
    DvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    EnableUllStreaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    EndTime string
    This specifies when the live media event ends.
    LiveType string
    The type of live 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.
    ShowAdvanced bool
    Allows you to configure advanced media options.
    StartTime string
    This specifies when the live media event begins.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvrType string
    The type of DVR.
    dvrWindow string
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime string
    This specifies when the live media event ends.
    liveType string
    The type of live 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.
    showAdvanced boolean
    Allows you to configure advanced media options.
    startTime string
    This specifies when the live media event begins.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Sets the type of media content to optimize.
    dvr_type str
    The type of DVR.
    dvr_window str
    Set the duration for your media, or 0m if a DVR is not required.
    enable_ull_streaming bool
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    end_time str
    This specifies when the live media event ends.
    live_type str
    The type of live 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.
    show_advanced bool
    Allows you to configure advanced media options.
    start_time str
    This specifies when the live media event begins.
    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
    Sets the type of media content to optimize.
    dvrType String
    The type of DVR.
    dvrWindow String
    Set the duration for your media, or 0m if a DVR is not required.
    enableUllStreaming Boolean
    Enables ultra low latency (ULL) streaming. ULL reduces latency and decreases overall transfer time of live streams.
    endTime String
    This specifies when the live media event ends.
    liveType String
    The type of live 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.
    showAdvanced Boolean
    Allows you to configure advanced media options.
    startTime String
    This specifies when the live media event begins.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSegmentedMediaStreamingPrefetch

    Enabled bool
    Enables media stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 stream prefetching.
    locked bool
    Indicates that your 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 stream prefetching.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSetVariable

    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    Algorithm string
    Specifies the algorithm to apply.
    CaseSensitive bool
    Enabling this makes all matches case sensitive.
    CertificateFieldName string
    Specifies the certificate's content.
    CookieName string
    Specifies the name of the cookie to extract.
    DeviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    EncryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    EncryptionMode string
    Specifies the encryption mode.
    EndIndex int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    ExceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    ExtractLocation string
    This specifies from where to get the value.
    ForceChars string
    Specifies characters to encode, possibly overriding the default set.
    FormatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    Generator string
    This specifies the type of value to generate.
    GlobalSubstitution bool
    Replaces all matches in the string, not just the first.
    HeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    HmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    HmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    InitializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    IpVersion string
    Specifies the IP version under which a subnet mask generates.
    Ipv4Prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    Ipv6Prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    LocationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    Locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    MaxRandomNumber int
    Specifies the upper bound of the random number.
    Min int
    Specifies a minimum value for the generated integer.
    MinRandomNumber int
    Specifies the lower bound of the random number.
    Nonce string
    Specifies the one-time number used for encryption.
    NumberOfBytes int
    Specifies the number of random hex bytes to generate.
    OperandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    ParamName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    PathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    PrependBytes bool
    Specifies a number of random bytes to prepend to the key.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    Regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    Replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    ResponseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    Separator string
    Specifies the character that separates pairs of values within the string.
    SetCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    StartIndex int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    SubString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    TemplateUuid string
    This option is for internal usage only.
    Transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValueSource string
    Determines how you want to set the value.
    VariableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    VariableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Integer
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Integer
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Integer
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Integer
    Specifies a maximum value for the generated integer.
    maxRandomNumber Integer
    Specifies the upper bound of the random number.
    min Integer
    Specifies a minimum value for the generated integer.
    minRandomNumber Integer
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Integer
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Integer
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm string
    Specifies the algorithm to apply.
    caseSensitive boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName string
    Specifies the certificate's content.
    cookieName string
    Specifies the name of the cookie to extract.
    deviceProfile string
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey string
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode string
    Specifies the encryption mode.
    endIndex number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars string
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation string
    This specifies from where to get the value.
    forceChars string
    Specifies characters to encode, possibly overriding the default set.
    formatString string
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator string
    This specifies the type of value to generate.
    globalSubstitution boolean
    Replaces all matches in the string, not just the first.
    headerName string
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm string
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey string
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector string
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion string
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId string
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked boolean
    Indicates 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 number
    Specifies a maximum value for the generated integer.
    maxRandomNumber number
    Specifies the upper bound of the random number.
    min number
    Specifies a minimum value for the generated integer.
    minRandomNumber number
    Specifies the lower bound of the random number.
    nonce string
    Specifies the one-time number used for encryption.
    numberOfBytes number
    Specifies the number of random hex bytes to generate.
    operandOne string
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName string
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset string
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the value.
    regex string
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement string
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName string
    Specifies the case-insensitive name of the HTTP header to extract.
    separator string
    Specifies the character that separates pairs of values within the string.
    setCookieName string
    Specifies the name of the origin's Set-Cookie response header.
    startIndex number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString string
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid string
    This option is for internal usage only.
    transform string
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource string
    Determines how you want to set the value.
    variableName string
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue string
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm str
    Specifies the algorithm to apply.
    case_sensitive bool
    Enabling this makes all matches case sensitive.
    certificate_field_name str
    Specifies the certificate's content.
    cookie_name str
    Specifies the name of the cookie to extract.
    device_profile str
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryption_key str
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryption_mode str
    Specifies the encryption mode.
    end_index int
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    except_chars str
    Specifies characters not to encode, possibly overriding the default set.
    extract_location str
    This specifies from where to get the value.
    force_chars str
    Specifies characters to encode, possibly overriding the default set.
    format_string str
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator str
    This specifies the type of value to generate.
    global_substitution bool
    Replaces all matches in the string, not just the first.
    header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    hmac_algorithm str
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmac_key str
    Specifies the secret to use in generating the base64-encoded digest.
    initialization_vector str
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ip_version str
    Specifies the IP version under which a subnet mask generates.
    ipv4_prefix int
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6_prefix int
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    location_id str
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked bool
    Indicates 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 int
    Specifies a maximum value for the generated integer.
    max_random_number int
    Specifies the upper bound of the random number.
    min int
    Specifies a minimum value for the generated integer.
    min_random_number int
    Specifies the lower bound of the random number.
    nonce str
    Specifies the one-time number used for encryption.
    number_of_bytes int
    Specifies the number of random hex bytes to generate.
    operand_one str
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    param_name str
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    path_component_offset str
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prepend_bytes bool
    Specifies a number of random bytes to prepend to the key.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the value.
    regex str
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement str
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    response_header_name str
    Specifies the case-insensitive name of the HTTP header to extract.
    separator str
    Specifies the character that separates pairs of values within the string.
    set_cookie_name str
    Specifies the name of the origin's Set-Cookie response header.
    start_index int
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    sub_string str
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    template_uuid str
    This option is for internal usage only.
    transform str
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    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_source str
    Determines how you want to set the value.
    variable_name str
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variable_value str
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.
    algorithm String
    Specifies the algorithm to apply.
    caseSensitive Boolean
    Enabling this makes all matches case sensitive.
    certificateFieldName String
    Specifies the certificate's content.
    cookieName String
    Specifies the name of the cookie to extract.
    deviceProfile String
    Specifies the client device attribute. Possible values specify information about the client device, including device type, size and browser. For details on fields, see Device Characterization.
    encryptionKey String
    Specifies the encryption hex key. For ALG_3DES it needs to be 48 characters long, 32 characters for ALG_AES128, and 64 characters for ALG_AES256.
    encryptionMode String
    Specifies the encryption mode.
    endIndex Number
    Specifies the zero-based character offset at the end of the substring, without including the character at that index position. Negative indexes specify the offset from the end of the string.
    exceptChars String
    Specifies characters not to encode, possibly overriding the default set.
    extractLocation String
    This specifies from where to get the value.
    forceChars String
    Specifies characters to encode, possibly overriding the default set.
    formatString String
    Specifies an optional format string for the conversion, using format codes such as %m/%d/%y as specified by strftime. A blank value defaults to RFC-2616 format.
    generator String
    This specifies the type of value to generate.
    globalSubstitution Boolean
    Replaces all matches in the string, not just the first.
    headerName String
    Specifies the case-insensitive name of the HTTP header to extract.
    hmacAlgorithm String
    Specifies the algorithm to use to generate the base64-encoded digest.
    hmacKey String
    Specifies the secret to use in generating the base64-encoded digest.
    initializationVector String
    Specifies a one-time number as an initialization vector. It needs to be 15 characters long for ALG_3DES, and 32 characters for both ALG_AES128 and ALG_AES256.
    ipVersion String
    Specifies the IP version under which a subnet mask generates.
    ipv4Prefix Number
    Specifies the prefix of the IPV4 address, a value between 0 and 32.
    ipv6Prefix Number
    Specifies the prefix of the IPV6 address, a value between 0 and 128.
    locationId String
    Specifies the X-Akamai-Edgescape header's field name. Possible values specify basic geolocation, various geographic standards, and information about the client's network. For details on EdgeScape header fields, see the EdgeScape User Guide.
    locked Boolean
    Indicates 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 Number
    Specifies a maximum value for the generated integer.
    maxRandomNumber Number
    Specifies the upper bound of the random number.
    min Number
    Specifies a minimum value for the generated integer.
    minRandomNumber Number
    Specifies the lower bound of the random number.
    nonce String
    Specifies the one-time number used for encryption.
    numberOfBytes Number
    Specifies the number of random hex bytes to generate.
    operandOne String
    Specifies an additional operand when the transform function is set to various arithmetic functions (ADD, SUBTRACT, MULTIPLY, DIVIDE, or MODULO) or bitwise functions (BITWISE_AND, BITWISE_OR, or BITWISE_XOR).
    paramName String
    Extracts the value for the specified parameter name from a string that contains key/value pairs. (Use separator below to parse them.)
    pathComponentOffset String
    This specifies a portion of the path. The indexing starts from 1, so a value of /path/to/nested/filename.html and an offset of 1 yields path, and 3 yields nested. Negative indexes offset from the right, so -2 also yields nested.
    prependBytes Boolean
    Specifies a number of random bytes to prepend to the key.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the value.
    regex String
    Specifies the regular expression pattern (PCRE) to match the value.
    replacement String
    Specifies the replacement string. Reinsert grouped items from the match into the replacement using $1, $2 ... $n.
    responseHeaderName String
    Specifies the case-insensitive name of the HTTP header to extract.
    separator String
    Specifies the character that separates pairs of values within the string.
    setCookieName String
    Specifies the name of the origin's Set-Cookie response header.
    startIndex Number
    Specifies the zero-based character offset at the start of the substring. Negative indexes specify the offset from the end of the string.
    subString String
    Specifies a substring for which the returned value represents a zero-based offset of where it appears in the original string, or -1 if there's no match.
    templateUuid String
    This option is for internal usage only.
    transform String
    Specifies a function to transform the value. For more details on each transform function, see Set Variable: Operations.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    valueSource String
    Determines how you want to set the value.
    variableName String
    Specifies the predeclared root name of the variable to modify. When you declare a variable name such as VAR, its name is preprended with PMUSER_ and accessible in a user namespace, so that you invoke it in subsequent text fields within the rule tree as {{user.PMUSER_VAR}}. In deployed XML metadata, it appears as %(PMUSER_VAR).
    variableValue String
    This directly specifies the value to assign to the variable. The expression may include a mix of static text and other variables, such as new_filename.{{builtin.AK_EXTENSION}} to embed a system variable.

    GetPropertyRulesBuilderRulesV20240212BehaviorSimulateErrorCode

    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ErrorType string
    Specifies the type of 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.
    TemplateUuid string
    This option is for internal usage only.
    Timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    errorType string
    Specifies the type of 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.
    templateUuid string
    This option is for internal usage only.
    timeout string
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    error_type str
    Specifies the type of 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.
    timeout str
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    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.
    errorType String
    Specifies the type of 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.
    templateUuid String
    This option is for internal usage only.
    timeout String
    When the errorType is ERR_CONNECT_TIMEOUT, ERR_DNS_TIMEOUT, ERR_SUREROUTE_DNS_FAIL, or ERR_READ_TIMEOUT, generates an error after the specified amount of time from the initial request.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSiteShield

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20240212BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    Ssmap GetPropertyRulesBuilderRulesV20240212BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20240212BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20240212BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    nossmap str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap GetPropertyRulesBuilderRulesV20240212BehaviorSiteShieldSsmap
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    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.
    nossmap String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    ssmap Property Map
    Identifies the hostname for the Site Shield map. See Create a Site Shield map for more details. Form an object with a value key that references the hostname, for example: "ssmap":{"value":"ss.akamai.net"}.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorSiteShieldSsmap

    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    ChinaCdnMap string
    HasMixedHosts bool
    Name string
    Src string
    Srmap string
    Value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String
    chinaCdnMap string
    hasMixedHosts boolean
    name string
    src string
    srmap string
    value string
    chinaCdnMap String
    hasMixedHosts Boolean
    name String
    src String
    srmap String
    value String

    GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigration

    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowHttpsDowngrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    AllowHttpsUpgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    CacheSharingDuration int
    Specifies the number cache sharing days.
    CacheSharingStartTime string
    Specifies when to start cache sharing.
    Enabled bool
    Allows migration to Standard TLS.
    IsCertificateSniOnly bool
    Sets whether your new certificate is SNI-only.
    IsTieredDistributionUsed bool
    Allows you to align traffic to various tieredDistribution areas.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MigrationDuration int
    Specifies the number of days to migrate the cache.
    MigrationFrom string
    What kind of traffic you're migrating from.
    MigrationStartTime string
    Specifies when to start migrating the cache.
    TdLocation string
    Specifies the tieredDistribution location.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Integer
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Integer
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowHttpsDowngrade boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration number
    Specifies the number cache sharing days.
    cacheSharingStartTime string
    Specifies when to start cache sharing.
    enabled boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration number
    Specifies the number of days to migrate the cache.
    migrationFrom string
    What kind of traffic you're migrating from.
    migrationStartTime string
    Specifies when to start migrating the cache.
    tdLocation string
    Specifies the tieredDistribution location.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_https_downgrade bool
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allow_https_upgrade bool
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cache_sharing_duration int
    Specifies the number cache sharing days.
    cache_sharing_start_time str
    Specifies when to start cache sharing.
    enabled bool
    Allows migration to Standard TLS.
    is_certificate_sni_only bool
    Sets whether your new certificate is SNI-only.
    is_tiered_distribution_used bool
    Allows you to align traffic to various tieredDistribution areas.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migration_duration int
    Specifies the number of days to migrate the cache.
    migration_from str
    What kind of traffic you're migrating from.
    migration_start_time str
    Specifies when to start migrating the cache.
    td_location str
    Specifies the tieredDistribution location.
    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.
    allowHttpsDowngrade Boolean
    Allow temporary downgrade of HTTPS traffic to HTTP. This removes various Origin, Referer, Cookie, Cookie2, sec-* and proxy-* headers from the request to origin.
    allowHttpsUpgrade Boolean
    Allows temporary upgrade of HTTP traffic to HTTPS.
    cacheSharingDuration Number
    Specifies the number cache sharing days.
    cacheSharingStartTime String
    Specifies when to start cache sharing.
    enabled Boolean
    Allows migration to Standard TLS.
    isCertificateSniOnly Boolean
    Sets whether your new certificate is SNI-only.
    isTieredDistributionUsed Boolean
    Allows you to align traffic to various tieredDistribution areas.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    migrationDuration Number
    Specifies the number of days to migrate the cache.
    migrationFrom String
    What kind of traffic you're migrating from.
    migrationStartTime String
    Specifies when to start migrating the cache.
    tdLocation String
    Specifies the tieredDistribution location.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorStandardTlsMigrationOverride

    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Info 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    info 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.
    info 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorStrictHeaderParsing

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    StrictMode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ValidMode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strict_mode bool
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers 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.
    valid_mode bool
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    strictMode Boolean
    Rejects requests made with non-RFC-compliant, improperly formatted headers, where the header line starts with a colon, misses a colon or doesn’t end with CR LF. When disabled, the edge servers allow such requests, but correct the violation by removing or rewriting the header line before passing the headers to the origin server.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    validMode Boolean
    Rejects requests made with non-RFC-compliant headers that contain invalid characters in the header name or value or which contain invalidly-folded header lines. When disabled, the edge servers allow such requests, passing the invalid headers to the origin server unchanged.

    GetPropertyRulesBuilderRulesV20240212BehaviorSubCustomer

    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    AccessControl bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    CacheKey bool
    Allows you to set which query parameters are included in the cache key.
    Caching bool
    Modifies content caching rules.
    ContentCompressor bool
    Allows compression of subcustomer content.
    DynamicWebContent bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    Enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    GeoLocation bool
    Sets subcustomers' location-based whitelists or blacklists.
    Ip bool
    Sets subcustomers' IP whitelists or blacklists.
    LargeFileDelivery bool
    Enables large file delivery for subcustomers.
    LiveVideoDelivery bool
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    ModifyPath bool
    Modifies a subcustomer's request path.
    OnDemandVideoDelivery bool
    Enables delivery of media assets to subcustomers.
    Origin bool
    Allows you to assign origin hostnames for customers.
    PartnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    Referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    RefreshContent bool
    Allows you to reschedule when content validates for subcustomers.
    SiteFailover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    TemplateUuid string
    This option is for internal usage only.
    TokenAuthorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    WebApplicationFirewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey boolean
    Allows you to set which query parameters are included in the cache key.
    caching boolean
    Modifies content caching rules.
    contentCompressor boolean
    Allows compression of subcustomer content.
    dynamicWebContent boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery boolean
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery boolean
    Enables delivery of media assets to subcustomers.
    origin boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix string
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid string
    This option is for internal usage only.
    tokenAuthorization boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    access_control bool
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cache_key bool
    Allows you to set which query parameters are included in the cache key.
    caching bool
    Modifies content caching rules.
    content_compressor bool
    Allows compression of subcustomer content.
    dynamic_web_content bool
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled bool
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geo_location bool
    Sets subcustomers' location-based whitelists or blacklists.
    ip bool
    Sets subcustomers' IP whitelists or blacklists.
    large_file_delivery bool
    Enables large file delivery for subcustomers.
    live_video_delivery bool
    locked bool
    Indicates 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_path bool
    Modifies a subcustomer's request path.
    on_demand_video_delivery bool
    Enables delivery of media assets to subcustomers.
    origin bool
    Allows you to assign origin hostnames for customers.
    partner_domain_suffix str
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer bool
    Sets subcustomers' referrer whitelists or blacklist.
    refresh_content bool
    Allows you to reschedule when content validates for subcustomers.
    site_failover bool
    Allows you to configure unique failover sites for each subcustomer's policy.
    template_uuid str
    This option is for internal usage only.
    token_authorization bool
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    web_application_firewall bool
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.
    accessControl Boolean
    When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
    cacheKey Boolean
    Allows you to set which query parameters are included in the cache key.
    caching Boolean
    Modifies content caching rules.
    contentCompressor Boolean
    Allows compression of subcustomer content.
    dynamicWebContent Boolean
    Allows you to apply the dynamicWebContent behavior to further modify how dynamic content behaves for subcustomers.
    enabled Boolean
    Allows Cloud Embed to dynamically modify your subcustomers' content.
    geoLocation Boolean
    Sets subcustomers' location-based whitelists or blacklists.
    ip Boolean
    Sets subcustomers' IP whitelists or blacklists.
    largeFileDelivery Boolean
    Enables large file delivery for subcustomers.
    liveVideoDelivery Boolean
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    modifyPath Boolean
    Modifies a subcustomer's request path.
    onDemandVideoDelivery Boolean
    Enables delivery of media assets to subcustomers.
    origin Boolean
    Allows you to assign origin hostnames for customers.
    partnerDomainSuffix String
    This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.com, then to purge subcustomer.com/some/path, specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
    referrer Boolean
    Sets subcustomers' referrer whitelists or blacklist.
    refreshContent Boolean
    Allows you to reschedule when content validates for subcustomers.
    siteFailover Boolean
    Allows you to configure unique failover sites for each subcustomer's policy.
    templateUuid String
    This option is for internal usage only.
    tokenAuthorization Boolean
    When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or 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.
    webApplicationFirewall Boolean
    Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.

    GetPropertyRulesBuilderRulesV20240212BehaviorSureRoute

    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AllowFcmParentOverride bool
    CustomMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    CustomStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    EnableCustomKey bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    Enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    ForceSslForward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    RaceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    SrDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    TemplateUuid string
    This option is for internal usage only.
    TestObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    ToHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    ToHostStatus string
    Specifies which hostname to use.
    Type string
    Specifies the set of edge servers used to test routes.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowFcmParentOverride boolean
    customMap string
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey string
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl string
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid string
    This option is for internal usage only.
    testObjectUrl string
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost string
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus string
    Specifies which hostname to use.
    type string
    Specifies the set of edge servers used to test routes.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_fcm_parent_override bool
    custom_map str
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    custom_stat_key str
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enable_custom_key bool
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled bool
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    force_ssl_forward bool
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    race_stat_ttl str
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    sr_download_link_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.
    test_object_url str
    Specifies the path and filename for your origin's test object to use in races to test routes.
    to_host str
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    to_host_status str
    Specifies which hostname to use.
    type str
    Specifies the set of edge servers used to test routes.
    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.
    allowFcmParentOverride Boolean
    customMap String
    If type is CUSTOM_MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
    customStatKey String
    This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.
    enableCustomKey Boolean
    When disabled, caches race results under the race destination's hostname. If enabled, use customStatKey to specify a custom hostname.
    enabled Boolean
    Enables the SureRoute behavior, to optimize delivery of non-cached content.
    forceSslForward Boolean
    Forces SureRoute to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    raceStatTtl String
    Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
    srDownloadLinkTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    templateUuid String
    This option is for internal usage only.
    testObjectUrl String
    Specifies the path and filename for your origin's test object to use in races to test routes.
    toHost String
    If toHostStatus is OTHER, this specifies the custom Host header to use when requesting the SureRoute test object.
    toHostStatus String
    Specifies which hostname to use.
    type String
    Specifies the set of edge servers used to test routes.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorTcpOptimization

    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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorTeaLeaf

    Enabled bool
    When enabled, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    IbmCustomerId int
    The integer identifier for the IBM Tealeaf Connector account.
    LimitToDynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Integer
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibm_customer_id int
    The integer identifier for the IBM Tealeaf Connector account.
    limit_to_dynamic bool
    Limit traffic to dynamic, uncached (No-Store) 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.
    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, capture HTTPS requests and responses, and send the data to your IBM Tealeaf account.
    ibmCustomerId Number
    The integer identifier for the IBM Tealeaf Connector account.
    limitToDynamic Boolean
    Limit traffic to dynamic, uncached (No-Store) 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistribution

    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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, activates tiered distribution.
    locked bool
    Indicates that your 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.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionAdvanced

    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Allowall bool
    Enabled bool
    When enabled, activates tiered distribution.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Method string
    Policy string
    TemplateUuid string
    This option is for internal usage only.
    TieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall boolean
    enabled boolean
    When enabled, activates tiered distribution.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method string
    policy string
    templateUuid string
    This option is for internal usage only.
    tieredDistributionMap string
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    allowall bool
    enabled bool
    When enabled, activates tiered distribution.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method str
    policy str
    template_uuid str
    This option is for internal usage only.
    tiered_distribution_map str
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    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.
    allowall Boolean
    enabled Boolean
    When enabled, activates tiered distribution.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    method String
    policy String
    templateUuid String
    This option is for internal usage only.
    tieredDistributionMap String
    Optionally map the tiered parent server's location close to your origin: CHEU2 for Europe; CHAUS for Australia; CHAPAC for China and the Asian Pacific area; CHWUS2, CHCUS2, and CHEUS2 for different parts of the United States. Choose CH or CH2 for a more global map. A narrower local map minimizes the origin server's load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server's cache. This option cannot apply if the property is marked as secure. See Secure property requirements for guidance.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorTieredDistributionCustomization

    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    CloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CustomMapEnabled bool
    Enables custom maps.
    CustomMapName string
    Specifies the custom map name.
    HashAlgorithm string
    Specifies the hash algorithm.
    Location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    MapMigrationEnabled bool
    Enables migration of the custom map to Cloud Wrapper.
    MigrationEndDate string
    Specifies when the map migration should end.
    MigrationStartDate string
    Specifies when to start migrating the map.
    MigrationWithinCwMapsEnabled bool
    Enables migration within Cloud Wrapper maps.
    SerialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    SerialStart string
    Specifies a numeric serial start value.
    TemplateUuid string
    This option is for internal usage only.
    Tier1Title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapperMapMigrationTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled boolean
    Enables custom maps.
    customMapName string
    Specifies the custom map name.
    hashAlgorithm string
    Specifies the hash algorithm.
    location string
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate string
    Specifies when the map migration should end.
    migrationStartDate string
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd string
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart string
    Specifies a numeric serial start value.
    templateUuid string
    This option is for internal usage only.
    tier1Title 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.
    cloudwrapper_map_migration_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    custom_map_enabled bool
    Enables custom maps.
    custom_map_name str
    Specifies the custom map name.
    hash_algorithm str
    Specifies the hash algorithm.
    location str
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    map_migration_enabled bool
    Enables migration of the custom map to Cloud Wrapper.
    migration_end_date str
    Specifies when the map migration should end.
    migration_start_date str
    Specifies when to start migrating the map.
    migration_within_cw_maps_enabled bool
    Enables migration within Cloud Wrapper maps.
    serial_end str
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serial_start str
    Specifies a numeric serial start value.
    template_uuid str
    This option is for internal usage only.
    tier1_title 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.
    cloudwrapperMapMigrationTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    customMapEnabled Boolean
    Enables custom maps.
    customMapName String
    Specifies the custom map name.
    hashAlgorithm String
    Specifies the hash algorithm.
    location String
    Location from which Cloud Wrapper migration is performed. User should choose the existing Cloud Wrapper location. The new Cloud Wrapper location (to which migration has to happen) is expected to be updated as part of the main "Cloud Wrapper" 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.
    mapMigrationEnabled Boolean
    Enables migration of the custom map to Cloud Wrapper.
    migrationEndDate String
    Specifies when the map migration should end.
    migrationStartDate String
    Specifies when to start migrating the map.
    migrationWithinCwMapsEnabled Boolean
    Enables migration within Cloud Wrapper maps.
    serialEnd String
    Specifies a numeric serial end value. Akamai uses serial numbers to group machines and share objects in their cache with other machines in the same region.
    serialStart String
    Specifies a numeric serial start value.
    templateUuid String
    This option is for internal usage only.
    tier1Title 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.
    locked bool
    Indicates that your 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 timeout, for example 10s.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 timeout, for example 10s.

    GetPropertyRulesBuilderRulesV20240212BehaviorUidConfiguration

    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    Enabled bool
    Allows you to extract UIDs from client requests.
    ExtractLocation string
    Where to extract the UID value from.
    HeaderName string
    This specifies the name of the HTTP header from which to extract the UID value.
    LegalText 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.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled boolean
    Allows you to extract UIDs from client requests.
    extractLocation string
    Where to extract the UID value from.
    headerName string
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName string
    This specifies the name of the rule tree variable from which to extract the UID value.
    enabled bool
    Allows you to extract UIDs from client requests.
    extract_location str
    Where to extract the UID value from.
    header_name str
    This specifies the name of the HTTP header from which to extract the UID value.
    legal_text 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.
    query_parameter_name str
    This specifies the name of the query parameter from which to extract the UID 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 rule tree variable from which to extract the UID value.
    enabled Boolean
    Allows you to extract UIDs from client requests.
    extractLocation String
    Where to extract the UID value from.
    headerName String
    This specifies the name of the HTTP header from which to extract the UID value.
    legalText 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.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the UID value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableName String
    This specifies the name of the rule tree variable from which to extract the UID value.

    GetPropertyRulesBuilderRulesV20240212BehaviorValidateEntityTag

    Enabled bool
    Enables the ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 ETag validation 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 ETag validation 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebToken

    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    ExtractLocation string
    Specify from where to extract the JWT value.
    HeaderName string
    This specifies the name of the header from which to extract the JWT value.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    QueryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation string
    Specify from where to extract the JWT value.
    headerName string
    This specifies the name of the header from which to extract the JWT value.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName string
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extract_location str
    Specify from where to extract the JWT value.
    header_name str
    This specifies the name of the header from which to extract the JWT value.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates 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_name str
    This specifies the name of the query parameter from which to extract the JWT 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.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps ensure that the token hasn't been tampered with.
    extractLocation String
    Specify from where to extract the JWT value.
    headerName String
    This specifies the name of the header from which to extract the JWT value.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    queryParameterName String
    This specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorVerifyJsonWebTokenForDcp

    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    Authorizations string
    This specifies the authorization group name.
    ClientId string
    This specifies the claim name.
    CustomHeader bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    EnableEs256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    EnableRs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    ExtractAuthorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    ExtractClientId bool
    Allows you to extract the client ID claim name stored in JWT.
    ExtractLocation string
    Specifies where to get the JWT value from.
    ExtractUserName bool
    Allows you to extract the user name stored in the JWT.
    HeaderName string
    This specifies the name of the header to extract the JWT value from.
    Jwt string
    An identifier for the JWT keys collection.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    PrimaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    QueryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    TemplateUuid string
    This option is for internal usage only.
    UserName string
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.
    authorizations string
    This specifies the authorization group name.
    clientId string
    This specifies the claim name.
    customHeader boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation string
    Specifies where to get the JWT value from.
    extractUserName boolean
    Allows you to extract the user name stored in the JWT.
    headerName string
    This specifies the name of the header to extract the JWT value from.
    jwt string
    An identifier for the JWT keys collection.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation string
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName string
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid string
    This option is for internal usage only.
    userName string
    This specifies the user 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.
    authorizations str
    This specifies the authorization group name.
    client_id str
    This specifies the claim name.
    custom_header bool
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enable_es256 bool
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enable_rs256 bool
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extract_authorizations bool
    Allows you to extract the authorization groups stored in the JWT.
    extract_client_id bool
    Allows you to extract the client ID claim name stored in JWT.
    extract_location str
    Specifies where to get the JWT value from.
    extract_user_name bool
    Allows you to extract the user name stored in the JWT.
    header_name str
    This specifies the name of the header to extract the JWT value from.
    jwt str
    An identifier for the JWT keys collection.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primary_location str
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    query_parameter_name str
    Specifies the name of the query parameter from which to extract the JWT value.
    template_uuid str
    This option is for internal usage only.
    user_name str
    This specifies the user 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.
    authorizations String
    This specifies the authorization group name.
    clientId String
    This specifies the claim name.
    customHeader Boolean
    The JWT value comes from the X-Akamai-DCP-Token header by default. Enabling this option allows you to extract it from another header name that you specify.
    enableEs256 Boolean
    Verifies JWTs signed with the ES256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    enableRs256 Boolean
    Verifies JWTs signed with the RS256 algorithm. This signature helps to ensure that the token hasn't been tampered with.
    extractAuthorizations Boolean
    Allows you to extract the authorization groups stored in the JWT.
    extractClientId Boolean
    Allows you to extract the client ID claim name stored in JWT.
    extractLocation String
    Specifies where to get the JWT value from.
    extractUserName Boolean
    Allows you to extract the user name stored in the JWT.
    headerName String
    This specifies the name of the header to extract the JWT value from.
    jwt String
    An identifier for the JWT keys collection.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    primaryLocation String
    Specifies the primary location to extract the JWT value from. If the specified option doesn't include the JWTs, the system checks the secondary one.
    queryParameterName String
    Specifies the name of the query parameter from which to extract the JWT value.
    templateUuid String
    This option is for internal usage only.
    userName String
    This specifies the user 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorVerifyTokenAuthorization

    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    EscapeHmacInputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    FailureResponse bool
    When enabled, sends an HTTP error when an authentication test fails.
    IgnoreQueryString bool
    Enabling this removes the query string from the URL used to form an encryption key.
    Key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    Location string
    Specifies where to find the token in the incoming request.
    LocationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    Salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    TemplateUuid string
    This option is for internal usage only.
    TransitionKey string
    Specifies a transition key as a hex value.
    UseAdvanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm string
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key string
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location string
    Specifies where to find the token in the incoming request.
    locationId string
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt string
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid string
    This option is for internal usage only.
    transitionKey string
    Specifies a transition key as a hex value.
    useAdvanced boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    algorithm str
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escape_hmac_inputs bool
    URL-escapes HMAC inputs passed in as query parameters.
    failure_response bool
    When enabled, sends an HTTP error when an authentication test fails.
    ignore_query_string bool
    Enabling this removes the query string from the URL used to form an encryption key.
    key str
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location str
    Specifies where to find the token in the incoming request.
    location_id str
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt str
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    template_uuid str
    This option is for internal usage only.
    transition_key str
    Specifies a transition key as a hex value.
    use_advanced bool
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    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.
    algorithm String
    Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.
    escapeHmacInputs Boolean
    URL-escapes HMAC inputs passed in as query parameters.
    failureResponse Boolean
    When enabled, sends an HTTP error when an authentication test fails.
    ignoreQueryString Boolean
    Enabling this removes the query string from the URL used to form an encryption key.
    key String
    The shared secret used to validate tokens, which needs to match the key used in the token generation code.
    location String
    Specifies where to find the token in the incoming request.
    locationId String
    When location is CLIENT_REQUEST_HEADER, specifies the name of the incoming request's header where to find the 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.
    salt String
    Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.
    templateUuid String
    This option is for internal usage only.
    transitionKey String
    Specifies a transition key as a hex value.
    useAdvanced Boolean
    If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoom

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Waiting Room Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the virtualWaitingRoom behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the virtualWaitingRoomRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorVirtualWaitingRoomWithEdgeWorkers

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritization

    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders List<string>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams List<string>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    AllowedUserCookieAdvanced bool
    Sets advanced configuration options for the allowed user's cookie.
    AllowedUserCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    AllowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    AllowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    AllowedUserCookieDuration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    AllowedUserCookieEnabled bool
    Sets a cookie for users who have been allowed through to the site.
    AllowedUserCookieHttpOnly bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    AllowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    AllowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AllowedUserCookieRefresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    AllowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    CloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    Enabled bool
    Enables the Visitor Prioritization 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.
    TemplateUuid string
    This option is for internal usage only.
    UserIdentificationByCookie bool
    When enabled, identifies users by the value of a cookie.
    UserIdentificationByHeaders bool
    When enabled, identifies users by the values of GET or POST request headers.
    UserIdentificationByIp bool
    Allows IP addresses to identify users.
    UserIdentificationByParams bool
    When enabled, identifies users by the values of GET or POST request parameters.
    UserIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    UserIdentificationKeyHeaders []string
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    UserIdentificationKeyParams []string
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    UserIdentificationTitle 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.
    WaitingRoomCacheTtl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    WaitingRoomCookieAdvanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    WaitingRoomCookieAutomaticSalt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    WaitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    WaitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    WaitingRoomCookieDuration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    WaitingRoomCookieEnabled bool
    Enables a cookie to track a waiting room assignment.
    WaitingRoomCookieHttpOnly bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    WaitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    WaitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    WaitingRoomCookieShareLabel bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    WaitingRoomCpCode GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    WaitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    WaitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    WaitingRoomNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    WaitingRoomStatusCode int
    Specifies the response code for requests sent to the waiting room.
    WaitingRoomUseCpCode bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Integer
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Integer
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Integer
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Integer
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain string
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType string
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel string
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled boolean
    Enables the Visitor Prioritization 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.
    templateUuid string
    This option is for internal usage only.
    userIdentificationByCookie boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp boolean
    Allows IP addresses to identify users.
    userIdentificationByParams boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie string
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders string[]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams string[]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain string
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType string
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel string
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt string
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory string
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowed_user_cookie_advanced bool
    Sets advanced configuration options for the allowed user's cookie.
    allowed_user_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowed_user_cookie_domain str
    Specifies a domain for an allowed user cookie.
    allowed_user_cookie_domain_type str
    Specify with allowedUserCookieAdvanced enabled.
    allowed_user_cookie_duration int
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowed_user_cookie_enabled bool
    Sets a cookie for users who have been allowed through to the site.
    allowed_user_cookie_http_only bool
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowed_user_cookie_label str
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowed_user_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowed_user_cookie_refresh bool
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowed_user_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudlet_policy GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationCloudletPolicy
    Identifies the Cloudlet policy.
    enabled bool
    Enables the Visitor Prioritization 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.
    user_identification_by_cookie bool
    When enabled, identifies users by the value of a cookie.
    user_identification_by_headers bool
    When enabled, identifies users by the values of GET or POST request headers.
    user_identification_by_ip bool
    Allows IP addresses to identify users.
    user_identification_by_params bool
    When enabled, identifies users by the values of GET or POST request parameters.
    user_identification_key_cookie str
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    user_identification_key_headers Sequence[str]
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    user_identification_key_params Sequence[str]
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    user_identification_title 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.
    waiting_room_cache_ttl int
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waiting_room_cookie_advanced bool
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waiting_room_cookie_automatic_salt bool
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waiting_room_cookie_domain str
    Specifies a domain for the waiting room cookie.
    waiting_room_cookie_domain_type str
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waiting_room_cookie_duration int
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waiting_room_cookie_enabled bool
    Enables a cookie to track a waiting room assignment.
    waiting_room_cookie_http_only bool
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waiting_room_cookie_label str
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waiting_room_cookie_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_cookie_salt str
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waiting_room_cookie_share_label bool
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waiting_room_cp_code GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCode
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waiting_room_directory str
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waiting_room_management_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waiting_room_net_storage GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomNetStorage
    Specifies the NetStorage domain for the waiting room page.
    waiting_room_status_code int
    Specifies the response code for requests sent to the waiting room.
    waiting_room_use_cp_code bool
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.
    allowedUserCookieAdvanced Boolean
    Sets advanced configuration options for the allowed user's cookie.
    allowedUserCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.
    allowedUserCookieDomain String
    Specifies a domain for an allowed user cookie.
    allowedUserCookieDomainType String
    Specify with allowedUserCookieAdvanced enabled.
    allowedUserCookieDuration Number
    Sets the number of seconds for the allowed user's session once allowed through to the site.
    allowedUserCookieEnabled Boolean
    Sets a cookie for users who have been allowed through to the site.
    allowedUserCookieHttpOnly Boolean
    Applies the HttpOnly flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
    allowedUserCookieLabel String
    Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.
    allowedUserCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    allowedUserCookieRefresh Boolean
    Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.
    allowedUserCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.
    cloudletPolicy Property Map
    Identifies the Cloudlet policy.
    enabled Boolean
    Enables the Visitor Prioritization 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.
    templateUuid String
    This option is for internal usage only.
    userIdentificationByCookie Boolean
    When enabled, identifies users by the value of a cookie.
    userIdentificationByHeaders Boolean
    When enabled, identifies users by the values of GET or POST request headers.
    userIdentificationByIp Boolean
    Allows IP addresses to identify users.
    userIdentificationByParams Boolean
    When enabled, identifies users by the values of GET or POST request parameters.
    userIdentificationKeyCookie String
    Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.
    userIdentificationKeyHeaders List<String>
    Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.
    userIdentificationKeyParams List<String>
    Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.
    userIdentificationTitle 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.
    waitingRoomCacheTtl Number
    Specifies the waiting room page's time to live in the cache, 5 minutes by default.
    waitingRoomCookieAdvanced Boolean
    When enabled along with waitingRoomCookieEnabled, sets advanced configuration options for the waiting room cookie.
    waitingRoomCookieAutomaticSalt Boolean
    Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.
    waitingRoomCookieDomain String
    Specifies a domain for the waiting room cookie.
    waitingRoomCookieDomainType String
    Specify with waitingRoomCookieAdvanced enabled, selects whether to use the DYNAMIC incoming host header, or a CUSTOMER-defined cookie domain.
    waitingRoomCookieDuration Number
    Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.
    waitingRoomCookieEnabled Boolean
    Enables a cookie to track a waiting room assignment.
    waitingRoomCookieHttpOnly Boolean
    Applies the HttpOnly flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
    waitingRoomCookieLabel String
    Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.
    waitingRoomCookieManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomCookieSalt String
    Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.
    waitingRoomCookieShareLabel Boolean
    Enabling this option shares the same allowedUserCookieLabel string. If disabled, specify a different waitingRoomCookieLabel.
    waitingRoomCpCode Property Map
    Specifies a CP code for requests sent to the waiting room. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
    waitingRoomDirectory String
    Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
    waitingRoomManagementTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    waitingRoomNetStorage Property Map
    Specifies the NetStorage domain for the waiting room page.
    waitingRoomStatusCode Number
    Specifies the response code for requests sent to the waiting room.
    waitingRoomUseCpCode Boolean
    Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationCloudletPolicy

    Id int
    Name string
    Id int
    Name string
    id Integer
    name String
    id number
    name string
    id int
    name str
    id Number
    name String

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifo

    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths List<string>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    AccessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CloudletSharedPolicy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    CustomCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    DomainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    SessionAutoProlong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    SessionDuration int
    Specifies the number of seconds users remain in the waiting room queue.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    WaitingRoomAssetsPaths []string
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    WaitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Integer
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Integer
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain string
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig string
    This specifies how to set the domain used to establish a session with the visitor.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths string[]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath string
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    access_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudlet_shared_policy int
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    custom_cookie_domain str
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domain_config str
    This specifies how to set the domain used to establish a session with the visitor.
    locked bool
    Indicates 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_auto_prolong bool
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    session_duration int
    Specifies the number of seconds users remain in the waiting room queue.
    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.
    waiting_room_assets_paths Sequence[str]
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_path str
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waiting_room_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    accessTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    cloudletSharedPolicy Number
    This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.
    customCookieDomain String
    This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the visitorPrioritizationFifo behavior. Don't use top level domains (TLDs).
    domainConfig String
    This specifies how to set the domain used to establish a session with the visitor.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    sessionAutoProlong Boolean
    Whether the queue session should prolong automatically when the sessionDuration expires and the visitor remains active.
    sessionDuration Number
    Specifies the number of seconds users remain in the waiting room queue.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    waitingRoomAssetsPaths List<String>
    This specifies the base paths to static resources such as JavaScript, CSS, or image files for the Waiting Room Main Page requests. The option supports the * wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomPath String
    This specifies the path to the waiting room main page on the origin server, for example /vp/waiting-room.html. When the request is marked as Waiting Room Main Page and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the waitingRoomPath and modifies the cache key accordingly. See the visitorPrioritizationRequest match criteria to further customize these requests.
    waitingRoomTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationFifoStandalone

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCode

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomCpCodeCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212BehaviorVisitorPrioritizationWaitingRoomNetStorage

    cpCode Integer
    downloadDomainName String
    g2oToken String

    GetPropertyRulesBuilderRulesV20240212BehaviorWatermarking

    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    AbVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    DecryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    DecryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    DecryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    DecryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    Enable bool
    Enables the watermarking 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.
    MiscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    PatternDecryptionEnable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    PatternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    SignatureVerificationEnable bool
    When enabled, you can verify the signature in your watermarking token.
    TemplateUuid string
    This option is for internal usage only.
    TokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    UseOriginalAsA bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VerificationKeyId1 string
    Specifies a unique identifier for the first public key.
    VerificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    VerificationPublicKey1 string
    Specifies the first public key in its entirety.
    VerificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation string
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 string
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 string
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 string
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 string
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid string
    This option is for internal usage only.
    tokenSigningTitle string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 string
    Specifies a unique identifier for the first public key.
    verificationKeyId2 string
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 string
    Specifies the first public key in its entirety.
    verificationPublicKey2 string
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    ab_variant_location str
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryption_password1 str
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryption_password2 str
    Provides the secondary password you can use to rotate passwords.
    decryption_password_id1 str
    Specifies a label that corresponds to the primary password.
    decryption_password_id2 str
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable bool
    Enables the watermarking 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.
    miscellaneous_settings_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    pattern_decryption_enable bool
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    pattern_encryption_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signature_verification_enable bool
    When enabled, you can verify the signature in your watermarking token.
    template_uuid str
    This option is for internal usage only.
    token_signing_title str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    use_original_as_a bool
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    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_key_id1 str
    Specifies a unique identifier for the first public key.
    verification_key_id2 str
    Specifies a unique identifier for the optional second public key.
    verification_public_key1 str
    Specifies the first public key in its entirety.
    verification_public_key2 str
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.
    abVariantLocation String
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the A and B variant segments.
    decryptionPassword1 String
    Provides the primary password used to encrypt patterns in your watermarking tokens.
    decryptionPassword2 String
    Provides the secondary password you can use to rotate passwords.
    decryptionPasswordId1 String
    Specifies a label that corresponds to the primary password.
    decryptionPasswordId2 String
    Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.
    enable Boolean
    Enables the watermarking 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.
    miscellaneousSettingsTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    patternDecryptionEnable Boolean
    If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.
    patternEncryptionTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    signatureVerificationEnable Boolean
    When enabled, you can verify the signature in your watermarking token.
    templateUuid String
    This option is for internal usage only.
    tokenSigningTitle String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    useOriginalAsA Boolean
    When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an A and B segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your A variant.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    verificationKeyId1 String
    Specifies a unique identifier for the first public key.
    verificationKeyId2 String
    Specifies a unique identifier for the optional second public key.
    verificationPublicKey1 String
    Specifies the first public key in its entirety.
    verificationPublicKey2 String
    Specifies the optional second public key in its entirety. Specify a second key to enable rotation.

    GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewall

    FirewallConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    FirewallConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewallConfiguration GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    firewall_configuration GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewallFirewallConfiguration
    An object featuring details about your firewall 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.
    firewallConfiguration Property Map
    An object featuring details about your firewall 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorWebApplicationFirewallFirewallConfiguration

    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ConfigId int
    FileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    ProductionVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    StagingVersion int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Integer
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Integer
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId number
    fileName string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    config_id int
    file_name str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    production_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_status str
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    staging_version int
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    configId Number
    fileName String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    productionVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingStatus String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior
    stagingVersion Number
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior

    GetPropertyRulesBuilderRulesV20240212BehaviorWebSockets

    Enabled bool
    Enables WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebSocket 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.
    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 WebSocket 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212BehaviorWebdav

    Enabled bool
    Enables the WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 WebDAV 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 WebDAV 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212Criterion

    AdvancedImMatch GetPropertyRulesBuilderRulesV20240212CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20240212CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20240212CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20240212CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20240212CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20240212CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20240212CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20240212CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20240212CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20240212CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20240212CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20240212CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20240212CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20240212CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20240212CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20240212CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20240212CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20240212CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20240212CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20240212CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20240212CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20240212CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20240212CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20240212CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20240212CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20240212CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20240212CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20240212CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20240212CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20240212CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20240212CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20240212CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20240212CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20240212CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20240212CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20240212CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20240212CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20240212CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20240212CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20240212CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240212CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240212CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    AdvancedImMatch GetPropertyRulesBuilderRulesV20240212CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    Bucket GetPropertyRulesBuilderRulesV20240212CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    Cacheability GetPropertyRulesBuilderRulesV20240212CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    ChinaCdnRegion GetPropertyRulesBuilderRulesV20240212CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    ClientCertificate GetPropertyRulesBuilderRulesV20240212CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    ClientIp GetPropertyRulesBuilderRulesV20240212CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    ClientIpVersion GetPropertyRulesBuilderRulesV20240212CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    CloudletsOrigin GetPropertyRulesBuilderRulesV20240212CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    ContentDeliveryNetwork GetPropertyRulesBuilderRulesV20240212CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    ContentType GetPropertyRulesBuilderRulesV20240212CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    DeviceCharacteristic GetPropertyRulesBuilderRulesV20240212CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    EcmdAuthGroups GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthGroups
    This criterion can be used in includes.
    EcmdAuthScheme GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthScheme
    This criterion can be used in includes.
    EcmdIsAuthenticated GetPropertyRulesBuilderRulesV20240212CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    EcmdUsername GetPropertyRulesBuilderRulesV20240212CriterionEcmdUsername
    This criterion can be used in includes.
    EdgeWorkersFailure GetPropertyRulesBuilderRulesV20240212CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    FileExtension GetPropertyRulesBuilderRulesV20240212CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    Filename GetPropertyRulesBuilderRulesV20240212CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    Hostname GetPropertyRulesBuilderRulesV20240212CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    MatchAdvanced GetPropertyRulesBuilderRulesV20240212CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    MatchCpCode GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    MatchResponseCode GetPropertyRulesBuilderRulesV20240212CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    MatchVariable GetPropertyRulesBuilderRulesV20240212CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    MetadataStage GetPropertyRulesBuilderRulesV20240212CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    OriginTimeout GetPropertyRulesBuilderRulesV20240212CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    Path GetPropertyRulesBuilderRulesV20240212CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    QueryStringParameter GetPropertyRulesBuilderRulesV20240212CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    Random GetPropertyRulesBuilderRulesV20240212CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    RecoveryConfig GetPropertyRulesBuilderRulesV20240212CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    RegularExpression GetPropertyRulesBuilderRulesV20240212CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    RequestCookie GetPropertyRulesBuilderRulesV20240212CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    RequestHeader GetPropertyRulesBuilderRulesV20240212CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    RequestMethod GetPropertyRulesBuilderRulesV20240212CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    RequestProtocol GetPropertyRulesBuilderRulesV20240212CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    RequestType GetPropertyRulesBuilderRulesV20240212CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    ResponseHeader GetPropertyRulesBuilderRulesV20240212CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    ServerLocation GetPropertyRulesBuilderRulesV20240212CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    Time GetPropertyRulesBuilderRulesV20240212CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    TokenAuthorization GetPropertyRulesBuilderRulesV20240212CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    UserAgent GetPropertyRulesBuilderRulesV20240212CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    UserLocation GetPropertyRulesBuilderRulesV20240212CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    UserNetwork GetPropertyRulesBuilderRulesV20240212CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    VariableError GetPropertyRulesBuilderRulesV20240212CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    VirtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240212CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    VisitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240212CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20240212CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20240212CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20240212CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20240212CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20240212CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20240212CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20240212CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20240212CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20240212CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20240212CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20240212CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20240212CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20240212CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20240212CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20240212CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20240212CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20240212CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20240212CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20240212CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20240212CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20240212CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20240212CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20240212CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20240212CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20240212CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20240212CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20240212CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20240212CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20240212CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20240212CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20240212CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20240212CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20240212CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20240212CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20240212CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20240212CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20240212CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20240212CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20240212CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20240212CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240212CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240212CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch GetPropertyRulesBuilderRulesV20240212CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20240212CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20240212CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion GetPropertyRulesBuilderRulesV20240212CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate GetPropertyRulesBuilderRulesV20240212CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp GetPropertyRulesBuilderRulesV20240212CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion GetPropertyRulesBuilderRulesV20240212CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin GetPropertyRulesBuilderRulesV20240212CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork GetPropertyRulesBuilderRulesV20240212CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType GetPropertyRulesBuilderRulesV20240212CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic GetPropertyRulesBuilderRulesV20240212CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmdAuthScheme GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmdIsAuthenticated GetPropertyRulesBuilderRulesV20240212CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmdUsername GetPropertyRulesBuilderRulesV20240212CriterionEcmdUsername
    This criterion can be used in includes.
    edgeWorkersFailure GetPropertyRulesBuilderRulesV20240212CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension GetPropertyRulesBuilderRulesV20240212CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20240212CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20240212CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced GetPropertyRulesBuilderRulesV20240212CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode GetPropertyRulesBuilderRulesV20240212CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable GetPropertyRulesBuilderRulesV20240212CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage GetPropertyRulesBuilderRulesV20240212CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout GetPropertyRulesBuilderRulesV20240212CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20240212CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter GetPropertyRulesBuilderRulesV20240212CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20240212CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig GetPropertyRulesBuilderRulesV20240212CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression GetPropertyRulesBuilderRulesV20240212CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie GetPropertyRulesBuilderRulesV20240212CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader GetPropertyRulesBuilderRulesV20240212CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod GetPropertyRulesBuilderRulesV20240212CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol GetPropertyRulesBuilderRulesV20240212CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType GetPropertyRulesBuilderRulesV20240212CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader GetPropertyRulesBuilderRulesV20240212CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation GetPropertyRulesBuilderRulesV20240212CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20240212CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization GetPropertyRulesBuilderRulesV20240212CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent GetPropertyRulesBuilderRulesV20240212CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation GetPropertyRulesBuilderRulesV20240212CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork GetPropertyRulesBuilderRulesV20240212CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError GetPropertyRulesBuilderRulesV20240212CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest GetPropertyRulesBuilderRulesV20240212CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest GetPropertyRulesBuilderRulesV20240212CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advanced_im_match GetPropertyRulesBuilderRulesV20240212CriterionAdvancedImMatch
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket GetPropertyRulesBuilderRulesV20240212CriterionBucket
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability GetPropertyRulesBuilderRulesV20240212CriterionCacheability
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    china_cdn_region GetPropertyRulesBuilderRulesV20240212CriterionChinaCdnRegion
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    client_certificate GetPropertyRulesBuilderRulesV20240212CriterionClientCertificate
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    client_ip GetPropertyRulesBuilderRulesV20240212CriterionClientIp
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    client_ip_version GetPropertyRulesBuilderRulesV20240212CriterionClientIpVersion
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudlets_origin GetPropertyRulesBuilderRulesV20240212CriterionCloudletsOrigin
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    content_delivery_network GetPropertyRulesBuilderRulesV20240212CriterionContentDeliveryNetwork
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    content_type GetPropertyRulesBuilderRulesV20240212CriterionContentType
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    device_characteristic GetPropertyRulesBuilderRulesV20240212CriterionDeviceCharacteristic
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmd_auth_groups GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthGroups
    This criterion can be used in includes.
    ecmd_auth_scheme GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthScheme
    This criterion can be used in includes.
    ecmd_is_authenticated GetPropertyRulesBuilderRulesV20240212CriterionEcmdIsAuthenticated
    This criterion can be used in includes.
    ecmd_username GetPropertyRulesBuilderRulesV20240212CriterionEcmdUsername
    This criterion can be used in includes.
    edge_workers_failure GetPropertyRulesBuilderRulesV20240212CriterionEdgeWorkersFailure
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    file_extension GetPropertyRulesBuilderRulesV20240212CriterionFileExtension
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename GetPropertyRulesBuilderRulesV20240212CriterionFilename
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname GetPropertyRulesBuilderRulesV20240212CriterionHostname
    Matches the requested hostname. This criterion can be used in includes.
    match_advanced GetPropertyRulesBuilderRulesV20240212CriterionMatchAdvanced
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    match_cp_code GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCode
    Match the assigned content provider code. This criterion can be used in includes.
    match_response_code GetPropertyRulesBuilderRulesV20240212CriterionMatchResponseCode
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    match_variable GetPropertyRulesBuilderRulesV20240212CriterionMatchVariable
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadata_stage GetPropertyRulesBuilderRulesV20240212CriterionMetadataStage
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    origin_timeout GetPropertyRulesBuilderRulesV20240212CriterionOriginTimeout
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path GetPropertyRulesBuilderRulesV20240212CriterionPath
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    query_string_parameter GetPropertyRulesBuilderRulesV20240212CriterionQueryStringParameter
    Matches query string field names or values. This criterion can be used in includes.
    random GetPropertyRulesBuilderRulesV20240212CriterionRandom
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recovery_config GetPropertyRulesBuilderRulesV20240212CriterionRecoveryConfig
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regular_expression GetPropertyRulesBuilderRulesV20240212CriterionRegularExpression
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    request_cookie GetPropertyRulesBuilderRulesV20240212CriterionRequestCookie
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    request_header GetPropertyRulesBuilderRulesV20240212CriterionRequestHeader
    Match HTTP header names or values. This criterion can be used in includes.
    request_method GetPropertyRulesBuilderRulesV20240212CriterionRequestMethod
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    request_protocol GetPropertyRulesBuilderRulesV20240212CriterionRequestProtocol
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    request_type GetPropertyRulesBuilderRulesV20240212CriterionRequestType
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    response_header GetPropertyRulesBuilderRulesV20240212CriterionResponseHeader
    Match HTTP header names or values. This criterion can be used in includes.
    server_location GetPropertyRulesBuilderRulesV20240212CriterionServerLocation
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time GetPropertyRulesBuilderRulesV20240212CriterionTime
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    token_authorization GetPropertyRulesBuilderRulesV20240212CriterionTokenAuthorization
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    user_agent GetPropertyRulesBuilderRulesV20240212CriterionUserAgent
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    user_location GetPropertyRulesBuilderRulesV20240212CriterionUserLocation
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    user_network GetPropertyRulesBuilderRulesV20240212CriterionUserNetwork
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variable_error GetPropertyRulesBuilderRulesV20240212CriterionVariableError
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtual_waiting_room_request GetPropertyRulesBuilderRulesV20240212CriterionVirtualWaitingRoomRequest
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitor_prioritization_request GetPropertyRulesBuilderRulesV20240212CriterionVisitorPrioritizationRequest
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    advancedImMatch Property Map
    Matches whether the imageManager behavior already applies to the current set of requests. This criterion can be used in includes.
    bucket Property Map
    This matches a specified percentage of requests when used with the accompanying behavior. Contact Akamai Professional Services for help configuring it. This criterion can be used in includes.
    cacheability Property Map
    Matches the current cache state. Note that any NO_STORE or BYPASS_CACHE HTTP headers set on the origin's content overrides properties' caching instructions, in which case this criteria does not apply. This criterion can be used in includes.
    chinaCdnRegion Property Map
    Identifies traffic deployed over Akamai's regional ChinaCDN infrastructure. This criterion can be used in includes.
    clientCertificate Property Map
    Matches whether you have configured a client certificate to authenticate requests to edge servers. This criterion can be used in includes.
    clientIp Property Map
    Matches the IP number of the requesting client. To use this condition to match end-user IP addresses, apply it together with the requestType matching on the CLIENT_REQ value. This criterion can be used in includes.
    clientIpVersion Property Map
    Matches the version of the IP protocol used by the requesting client. This criterion can be used in includes.
    cloudletsOrigin Property Map
    Allows Cloudlets Origins, referenced by label, to define their own criteria to assign custom origin definitions. The criteria may match, for example, for a specified percentage of requests defined by the cloudlet to use an alternative version of a website. This criterion can be used in includes.
    contentDeliveryNetwork Property Map
    Specifies the type of Akamai network handling the request. This criterion can be used in includes.
    contentType Property Map
    Matches the HTTP response header's Content-Type. This criterion can be used in includes.
    deviceCharacteristic Property Map
    Match various aspects of the device or browser making the request. Based on the value of the characteristic option, the expected value is either a boolean, a number, or a string, possibly representing a version number. Each type of value requires a different field. This criterion can be used in includes.
    ecmdAuthGroups Property Map
    This criterion can be used in includes.
    ecmdAuthScheme Property Map
    This criterion can be used in includes.
    ecmdIsAuthenticated Property Map
    This criterion can be used in includes.
    ecmdUsername Property Map
    This criterion can be used in includes.
    edgeWorkersFailure Property Map
    Checks the EdgeWorkers execution status and detects whether a customer's JavaScript failed on edge servers. This criterion can be used in includes.
    fileExtension Property Map
    Matches the requested filename's extension, if present. This criterion can be used in includes.
    filename Property Map
    Matches the requested filename, or test whether it is present. This criterion can be used in includes.
    hostname Property Map
    Matches the requested hostname. This criterion can be used in includes.
    matchAdvanced Property Map
    This specifies match criteria using Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This criterion is for internal usage only. This criterion can be used in includes.
    matchCpCode Property Map
    Match the assigned content provider code. This criterion can be used in includes.
    matchResponseCode Property Map
    Match a set or range of HTTP response codes. This criterion can be used in includes.
    matchVariable Property Map
    Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable behavior. See Support for variables for more information on this feature. This criterion can be used in includes.
    metadataStage Property Map
    Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    originTimeout Property Map
    Matches when the origin responds with a timeout error. This criterion can be used in includes.
    path Property Map
    Matches the URL's non-hostname path component. This criterion can be used in includes.
    queryStringParameter Property Map
    Matches query string field names or values. This criterion can be used in includes.
    random Property Map
    Matches a specified percentage of requests. Use this match to apply behaviors to a percentage of your incoming requests that differ from the remainder, useful for A/b testing, or to offload traffic onto different servers. This criterion can be used in includes.
    recoveryConfig Property Map
    Matches on specified origin recovery scenarios. The originFailureRecoveryPolicy behavior defines the scenarios that trigger the recovery or retry methods you set in the originFailureRecoveryMethod rule. If the origin fails, the system checks the name of the recovery method applied to your policy. It then either redirects the requesting client to a backup origin or returns predefined HTTP response codes. This criterion can be used in includes.
    regularExpression Property Map
    Matches a regular expression against a string, especially to apply behaviors flexibly based on the contents of dynamic variables. This criterion can be used in includes.
    requestCookie Property Map
    Match the cookie name or value passed with the request. This criterion can be used in includes.
    requestHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    requestMethod Property Map
    Specify the request's HTTP verb. Also supports WebDAV methods and common Akamai operations. This criterion can be used in includes.
    requestProtocol Property Map
    Matches whether the request uses the HTTP or HTTPS protocol. This criterion can be used in includes.
    requestType Property Map
    Matches the basic type of request. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production. This criterion can be used in includes.
    responseHeader Property Map
    Match HTTP header names or values. This criterion can be used in includes.
    serverLocation Property Map
    The location of the Akamai server handling the request. This criterion can be used in includes.
    time Property Map
    Specifies ranges of times during which the request occurred. This criterion can be used in includes.
    tokenAuthorization Property Map
    Match on Auth Token 2.0 verification results. This criterion can be used in includes.
    userAgent Property Map
    Matches the user agent string that helps identify the client browser and device. This criterion can be used in includes.
    userLocation Property Map
    The client browser's approximate geographic location, determined by looking up the IP address in a database. This criterion can be used in includes.
    userNetwork Property Map
    Matches details of the network over which the request was made, determined by looking up the IP address in a database. This criterion can be used in includes.
    variableError Property Map
    Matches any runtime errors that occur on edge servers based on the configuration of a setVariable behavior. See Support for variables section for more information on this feature. This criterion can be used in includes.
    virtualWaitingRoomRequest Property Map
    Helps to customize the requests identified by the virtualWaitingRoom behavior. Use this match criteria to define the originServer behavior for the waiting room. This criterion cannot be used in includes.
    visitorPrioritizationRequest Property Map
    Helps to customize the requests identified by the visitorPrioritizationFifo behavior. The basic use case for this match criteria is to define the originServer behavior for the waiting room. This criterion cannot be used in includes.

    GetPropertyRulesBuilderRulesV20240212CriterionAdvancedImMatch

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the match's scope.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the match's scope.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the match's scope.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the match's scope.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionBucket

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    Percentage int
    Specifies the percentage of requests to match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage Integer
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage number
    Specifies the percentage of requests to match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    percentage int
    Specifies the percentage of requests to match.
    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.
    percentage Number
    Specifies the percentage of requests to match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionCacheability

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    match_operator str
    Specifies the match's logic.
    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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_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.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Content's cache is enabled (CACHEABLE) or not (NO_STORE), or else is ignored (BYPASS_CACHE).

    GetPropertyRulesBuilderRulesV20240212CriterionChinaCdnRegion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    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.
    matchOperator String
    Specify whether the request IS or IS_NOT deployed over ChinaCDN.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionClientCertificate

    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    EnforceMtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    IsCertificatePresent bool
    Executes rule behaviors only if a client certificate authenticates requests.
    IsCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforceMtls boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid string
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    enforce_mtls bool
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    is_certificate_present bool
    Executes rule behaviors only if a client certificate authenticates requests.
    is_certificate_valid str
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked bool
    Indicates that your 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.
    enforceMtls Boolean
    Specifies custom handling of requests if any of the checks in the enforceMtlsSettings behavior fail. Enable this and use with behaviors such as logCustom so that they execute if the check fails. You need to add the enforceMtlsSettings behavior to a parent rule, with its own unique match condition and enableDenyRequest option disabled.
    isCertificatePresent Boolean
    Executes rule behaviors only if a client certificate authenticates requests.
    isCertificateValid String
    Matches whether the certificate is VALID or INVALID. You can also IGNORE the certificate's validity.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionClientIp

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    IP or CIDR block, for example: 71.92.0.0/14.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    UseHeaders bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    useHeaders boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked bool
    Indicates 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_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    template_uuid str
    This option is for internal usage only.
    use_headers bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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.
    values Sequence[str]
    IP or CIDR block, for example: 71.92.0.0/14.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    useHeaders Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    IP or CIDR block, for example: 71.92.0.0/14.

    GetPropertyRulesBuilderRulesV20240212CriterionClientIpVersion

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    UseXForwardedFor bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    useXForwardedFor boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.
    locked bool
    Indicates that your 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_x_forwarded_for bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    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
    The IP version of the client request, either IPV4 or IPV6.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    useXForwardedFor Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the connecting client's IP address rather than the original end client specified in the header.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The IP version of the client request, either IPV4 or IPV6.

    GetPropertyRulesBuilderRulesV20240212CriterionCloudletsOrigin

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    OriginId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    originId string
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The Cloudlets Origins identifier, limited to alphanumeric and underscore 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.
    originId String
    The Cloudlets Origins identifier, limited to alphanumeric and underscore characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionContentDeliveryNetwork

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    Network string
    Match the network.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network string
    Match the network.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network str
    Match the network.
    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.
    matchOperator String
    Matches the specified network if set to IS, otherwise IS_NOT reverses the match.
    network String
    Match the network.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionContentType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Content-Type response header value, for example text/html.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for all values.
    MatchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for all values.
    matchOperator string
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Content-Type response header value, for example text/html.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for all values.
    match_operator str
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    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.
    values Sequence[str]
    Content-Type response header value, for example text/html.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for all values.
    matchOperator String
    Matches any Content-Type among specified values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. Specifying text/* matches both text/html and text/css.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Content-Type response header value, for example text/html.

    GetPropertyRulesBuilderRulesV20240212CriterionDeviceCharacteristic

    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues List<string>
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    BooleanValue bool
    When the characteristic expects a boolean value, this specifies the value.
    Characteristic string
    Aspect of the device or browser 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.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the stringValue field.
    MatchWildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    NumericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    NumericValue int
    When the characteristic expects a numeric value, this specifies the number.
    StringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    StringValues []string
    When the characteristic expects a string, this specifies the set of values.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VersionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    VersionValue string
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Integer
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic string
    Aspect of the device or browser 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.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator string
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator string
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues string[]
    When the characteristic expects a string, this specifies the set of values.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator string
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue string
    When the characteristic expects a version number, this specifies it as a string.
    boolean_value bool
    When the characteristic expects a boolean value, this specifies the value.
    characteristic str
    Aspect of the device or browser 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_case_sensitive bool
    Sets a case-sensitive match for the stringValue field.
    match_wildcard bool
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numeric_match_operator str
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numeric_value int
    When the characteristic expects a numeric value, this specifies the number.
    string_match_operator str
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    string_values Sequence[str]
    When the characteristic expects a string, this specifies the set of values.
    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.
    version_match_operator str
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    version_value str
    When the characteristic expects a version number, this specifies it as a string.
    booleanValue Boolean
    When the characteristic expects a boolean value, this specifies the value.
    characteristic String
    Aspect of the device or browser 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.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the stringValue field.
    matchWildcard Boolean
    Allows wildcards in the stringValue field, where ? matches a single character and * matches zero or more characters.
    numericMatchOperator String
    When the characteristic expects a numeric value, compares the specified numericValue against the matched client.
    numericValue Number
    When the characteristic expects a numeric value, this specifies the number.
    stringMatchOperator String
    When the characteristic expects a string value, set this to MATCHES_ONE_OF to match against the stringValue set, otherwise set to DOES_NOT_MATCH_ONE_OF to exclude that set of values.
    stringValues List<String>
    When the characteristic expects a string, this specifies the set of values.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    versionMatchOperator String
    When the characteristic expects a version string value, compares the specified versionValue against the matched client, using the following operators: IS, IS_MORE_THAN_OR_EQUAL, IS_MORE_THAN, IS_LESS_THAN_OR_EQUAL, IS_LESS_THAN, IS_NOT.
    versionValue String
    When the characteristic expects a version number, this specifies it as a string.

    GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthGroups

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    locked bool
    Indicates 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_operator 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.
    value str
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20240212CriterionEcmdAuthScheme

    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    AuthScheme 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    authScheme 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    auth_scheme 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.
    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.
    authScheme 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionEcmdIsAuthenticated

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionEcmdUsername

    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Length 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.
    MatchOperator string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    matchOperator string
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    length 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.
    match_operator 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.
    value str
    length 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.
    matchOperator String
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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

    GetPropertyRulesBuilderRulesV20240212CriterionEdgeWorkersFailure

    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ExecStatus string
    Specify execution status.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    execStatus string
    Specify execution status.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    exec_status str
    Specify execution status.
    locked bool
    Indicates that your 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.
    execStatus String
    Specify execution status.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionFileExtension

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of values if set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    An array of file extension strings, with no leading dot characters, for example png, jpg, jpeg, and gif.

    GetPropertyRulesBuilderRulesV20240212CriterionFilename

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the values field.
    MatchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the values field.
    matchOperator string
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the values field.
    match_operator str
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    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.
    values Sequence[str]
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the values field.
    matchOperator String
    If set to IS_ONE_OF or IS_NOT_ONE_OF, matches whether the filename matches one of the values. If set to IS_EMPTY or IS_NOT_EMPTY, matches whether the specified filename is part of the path.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the filename component of the request URL. Allows wildcards, where ? matches a single character and * matches zero or more characters. For example, specify filename.* to accept any extension.

    GetPropertyRulesBuilderRulesV20240212CriterionHostname

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked bool
    Indicates 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_operator str
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    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.
    values Sequence[str]
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the contents of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A list of hostnames. Allows wildcards, where ? matches a single character and * matches zero or more characters. Specifying *.example.com matches both m.example.com and www.example.com.

    GetPropertyRulesBuilderRulesV20240212CriterionMatchAdvanced

    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CloseXml string
    An XML string that closes the relevant block.
    Description string
    A 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.
    OpenXml string
    An XML string that opens the relevant block.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    closeXml string
    An XML string that closes the relevant block.
    description string
    A 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.
    openXml string
    An XML string that opens the relevant block.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    close_xml str
    An XML string that closes the relevant block.
    description str
    A 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.
    open_xml str
    An XML string that opens the relevant block.
    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.
    closeXml String
    An XML string that closes the relevant block.
    description String
    A 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.
    openXml String
    An XML string that opens the relevant block.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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 GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValue
    Specifies the CP code as an object. You only need to provide the initial id to match the CP code, stripping any cpc_ 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 to match the CP code, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

    GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValue

    CpCodeLimits GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    CpCodeLimits GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CreatedDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.
    cpCodeLimits GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValueCpCodeLimits
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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_limits GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValueCpCodeLimits
    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.
    cpCodeLimits Property Map
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    createdDate 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.

    GetPropertyRulesBuilderRulesV20240212CriterionMatchCpCodeValueCpCodeLimits

    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    CurrentCapacity 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.
    LimitType string
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
    currentCapacity 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.
    limitType 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.
    currentCapacity 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.
    limitType String
    This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.

    GetPropertyRulesBuilderRulesV20240212CriterionMatchResponseCode

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    A set of response codes to match, for example ["404","500"].
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    MatchOperator string
    Matches numeric range or a specified set of values.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator string
    Matches numeric range or a specified set of values.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    A set of response codes to match, for example ["404","500"].
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    match_operator str
    Matches numeric range or a specified set of values.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    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.
    values Sequence[str]
    A set of response codes to match, for example ["404","500"].
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the start of a range of responses. For example, 400 to match anything from 400 to 500.
    matchOperator String
    Matches numeric range or a specified set of values.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    Specifies the end of a range of responses. For example, 500 to match anything from 400 to 500.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    A set of response codes to match, for example ["404","500"].

    GetPropertyRulesBuilderRulesV20240212CriterionMatchVariable

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues List<string>
    Specifies an array of matching strings.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound string
    Specifies the range's numeric minimum value.
    MatchCaseSensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    MatchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    MatchWildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound string
    Specifies the range's numeric maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableExpression string
    Specifies a single matching string.
    VariableName string
    The name of the variable to match.
    VariableValues []string
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound string
    Specifies the range's numeric minimum value.
    matchCaseSensitive boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator string
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound string
    Specifies the range's numeric maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression string
    Specifies a single matching string.
    variableName string
    The name of the variable to match.
    variableValues string[]
    Specifies an array of matching strings.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound str
    Specifies the range's numeric minimum value.
    match_case_sensitive bool
    When matching string expressions, enabling this performs a case-sensitive match.
    match_operator str
    The type of match, based on which you use different options to specify the match criteria.
    match_wildcard bool
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound str
    Specifies the range's numeric maximum value.
    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_expression str
    Specifies a single matching string.
    variable_name str
    The name of the variable to match.
    variable_values Sequence[str]
    Specifies an array of matching strings.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound String
    Specifies the range's numeric minimum value.
    matchCaseSensitive Boolean
    When matching string expressions, enabling this performs a case-sensitive match.
    matchOperator String
    The type of match, based on which you use different options to specify the match criteria.
    matchWildcard Boolean
    When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound String
    Specifies the range's numeric maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableExpression String
    Specifies a single matching string.
    variableName String
    The name of the variable to match.
    variableValues List<String>
    Specifies an array of matching strings.

    GetPropertyRulesBuilderRulesV20240212CriterionMetadataStage

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Compares the current rule with the specified metadata stage.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Compares the current rule with the specified metadata stage.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.
    locked bool
    Indicates 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_operator str
    Compares the current rule with the specified metadata stage.
    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 metadata stage.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Compares the current rule with the specified metadata stage.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 metadata stage.

    GetPropertyRulesBuilderRulesV20240212CriterionOriginTimeout

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Specifies a single required ORIGIN_TIMED_OUT 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.
    matchOperator String
    Specifies a single required ORIGIN_TIMED_OUT value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionPath

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match.
    MatchOperator string
    Matches the contents of the values array.
    Normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match.
    matchOperator string
    Matches the contents of the values array.
    normalize boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match.
    match_operator str
    Matches the contents of the values array.
    normalize bool
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    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.
    values Sequence[str]
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match.
    matchOperator String
    Matches the contents of the values array.
    normalize Boolean
    Transforms URLs before comparing them with the provided value. URLs are decoded, and any directory syntax such as ../.. or // is stripped as a security measure. This protects URL paths from being accessed by unauthorized users.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    Matches the URL path, excluding leading hostname and trailing query parameters. The path is relative to the server root, for example /blog. This field allows wildcards, where ? matches a single character and * matches zero or more characters. For example, /blog/*/2014 matches paths with two fixed segments and other varying segments between them.

    GetPropertyRulesBuilderRulesV20240212CriterionQueryStringParameter

    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The value of the query field, for example, string in ?q=string.
    EscapeValue bool
    Matches when the value is URL-escaped.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    Specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the parameterName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    ParameterName string
    The name of the query field, for example, q in ?q=string.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.
    escapeValue boolean
    Matches when the value is URL-escaped.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    Specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName string
    The name of the query field, for example, q in ?q=string.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The value of the query field, for example, string in ?q=string.
    escape_value bool
    Matches when the value is URL-escaped.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    Specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the parameterName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameter_name str
    The name of the query field, for example, q in ?q=string.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The value of the query field, for example, string in ?q=string.
    escapeValue Boolean
    Matches when the value is URL-escaped.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    Specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the parameterName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the parameterName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    parameterName String
    The name of the query field, for example, q in ?q=string.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The value of the query field, for example, string in ?q=string.

    GetPropertyRulesBuilderRulesV20240212CriterionRandom

    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket Integer
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bucket int
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    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.
    bucket Number
    Specify a percentage of random requests to which to apply a behavior. Any remainders do not 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.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionRecoveryConfig

    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ConfigName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    configName string
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    config_name str
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked bool
    Indicates that your 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.
    configName String
    A unique identifier used for origin failure recovery configurations. This is the recovery method configuration name you apply when setting origin failure recovery methods and scenarios in originFailureRecoveryMethod and originFailureRecoveryPolicy behaviors. The value can contain alphanumeric characters and dashes.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionRegularExpression

    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CaseSensitive bool
    Sets a case-sensitive regular expression 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.
    MatchString string
    The string to match, typically the contents of a dynamic variable.
    Regex string
    The regular expression (PCRE) to match against the string.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    caseSensitive boolean
    Sets a case-sensitive regular expression 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.
    matchString string
    The string to match, typically the contents of a dynamic variable.
    regex string
    The regular expression (PCRE) to match against the string.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    case_sensitive bool
    Sets a case-sensitive regular expression 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_string str
    The string to match, typically the contents of a dynamic variable.
    regex str
    The regular expression (PCRE) to match against the string.
    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.
    caseSensitive Boolean
    Sets a case-sensitive regular expression 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.
    matchString String
    The string to match, typically the contents of a dynamic variable.
    regex String
    The regular expression (PCRE) to match against the string.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionRequestCookie

    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    CookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveName bool
    Sets a case-sensitive match for the cookieName field.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookieName string
    The name of the cookie, for example, visitor in visitor:anon.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.
    cookie_name str
    The name of the cookie, for example, visitor in visitor:anon.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_name bool
    Sets a case-sensitive match for the cookieName field.
    match_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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
    The cookie's value, for example, anon in visitor:anon.
    cookieName String
    The name of the cookie, for example, visitor in visitor:anon.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveName Boolean
    Sets a case-sensitive match for the cookieName field.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the cookieName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    The cookie's value, for example, anon in visitor:anon.

    GetPropertyRulesBuilderRulesV20240212CriterionRequestHeader

    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    HeaderName string
    The name of the request header, for example Accept-Language.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitiveValue bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Narrows the match criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName string
    The name of the request header, for example Accept-Language.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Narrows the match criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    header_name str
    The name of the request header, for example Accept-Language.
    locked bool
    Indicates 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_case_sensitive_value bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Narrows the match criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more 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.
    values Sequence[str]
    The request header's value, for example en-US when the header headerName is Accept-Language.
    headerName String
    The name of the request header, for example Accept-Language.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitiveValue Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Narrows the match criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The request header's value, for example en-US when the header headerName is Accept-Language.

    GetPropertyRulesBuilderRulesV20240212CriterionRequestMethod

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked bool
    Indicates 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_operator str
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the value when set to IS, otherwise IS_NOT reverses the match.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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
    Any of these HTTP methods, WebDAV methods, or Akamai operations.

    GetPropertyRulesBuilderRulesV20240212CriterionRequestProtocol

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.
    locked bool
    Indicates that your 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 protocol.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 protocol.

    GetPropertyRulesBuilderRulesV20240212CriterionRequestType

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked bool
    Indicates 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_operator str
    Specifies whether the request IS or IS_NOT the type of specified 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.
    value str
    Specifies the type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies whether the request IS or IS_NOT the type of specified value.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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 type of request, either a standard CLIENT_REQ, an ESI_FRAGMENT, or an EW_SUBREQUEST.

    GetPropertyRulesBuilderRulesV20240212CriterionResponseHeader

    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    HeaderName string
    The name of the response header, for example Content-Type.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    LowerBound int
    When the value is numeric, this field specifies the match's minimum value.
    MatchCaseSensitiveValue bool
    When enabled, the match is case-sensitive for the value field.
    MatchOperator string
    Narrows the match according to various criteria.
    MatchWildcardName bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    MatchWildcardValue bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    TemplateUuid string
    This option is for internal usage only.
    UpperBound int
    When the value is numeric, this field specifies the match's maximum value.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Integer
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Integer
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName string
    The name of the response header, for example Content-Type.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator string
    Narrows the match according to various criteria.
    matchWildcardName boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid string
    This option is for internal usage only.
    upperBound number
    When the value is numeric, this field specifies the match's maximum value.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    header_name str
    The name of the response header, for example Content-Type.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lower_bound int
    When the value is numeric, this field specifies the match's minimum value.
    match_case_sensitive_value bool
    When enabled, the match is case-sensitive for the value field.
    match_operator str
    Narrows the match according to various criteria.
    match_wildcard_name bool
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    match_wildcard_value bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    template_uuid str
    This option is for internal usage only.
    upper_bound int
    When the value is numeric, this field specifies the match's maximum value.
    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.
    values Sequence[str]
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.
    headerName String
    The name of the response header, for example Content-Type.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    lowerBound Number
    When the value is numeric, this field specifies the match's minimum value.
    matchCaseSensitiveValue Boolean
    When enabled, the match is case-sensitive for the value field.
    matchOperator String
    Narrows the match according to various criteria.
    matchWildcardName Boolean
    Allows wildcards in the headerName field, where ? matches a single character and * matches zero or more characters.
    matchWildcardValue Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
    templateUuid String
    This option is for internal usage only.
    upperBound Number
    When the value is numeric, this field specifies the match's maximum value.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The response header's value, for example application/x-www-form-urlencoded when the header headerName is Content-Type.

    GetPropertyRulesBuilderRulesV20240212CriterionServerLocation

    Continents List<string>
    Continent codes.
    Countries List<string>
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Continents []string
    Continent codes.
    Countries []string
    ISO 3166-1 country codes, such as US or CN.
    LocationType string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    Regions []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents string[]
    Continent codes.
    countries string[]
    ISO 3166-1 country codes, such as US or CN.
    locationType string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    continents Sequence[str]
    Continent codes.
    countries Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    location_type str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    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.
    continents List<String>
    Continent codes.
    countries List<String>
    ISO 3166-1 country codes, such as US or CN.
    locationType String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regions List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionTime

    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    ApplyDaylightSavingsTime bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    BeginDate string
    Sets the start of a time period.
    EndDate string
    Sets the end of a fixed time period.
    LastingDate string
    Sets the start of a fixed time period.
    LastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Specifies how to define the range of time.
    RepeatBeginDate string
    Sets the start of the initial time period.
    RepeatDuration string
    Sets the duration of each repeating time period.
    RepeatInterval string
    Sets the time between each repeating time period's starting points.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    applyDaylightSavingsTime boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate string
    Sets the start of a time period.
    endDate string
    Sets the end of a fixed time period.
    lastingDate string
    Sets the start of a fixed time period.
    lastingDuration string
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Specifies how to define the range of time.
    repeatBeginDate string
    Sets the start of the initial time period.
    repeatDuration string
    Sets the duration of each repeating time period.
    repeatInterval string
    Sets the time between each repeating time period's starting points.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    apply_daylight_savings_time bool
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    begin_date str
    Sets the start of a time period.
    end_date str
    Sets the end of a fixed time period.
    lasting_date str
    Sets the start of a fixed time period.
    lasting_duration str
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked bool
    Indicates 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_operator str
    Specifies how to define the range of time.
    repeat_begin_date str
    Sets the start of the initial time period.
    repeat_duration str
    Sets the duration of each repeating time period.
    repeat_interval str
    Sets the time between each repeating time period's starting points.
    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.
    applyDaylightSavingsTime Boolean
    Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
    beginDate String
    Sets the start of a time period.
    endDate String
    Sets the end of a fixed time period.
    lastingDate String
    Sets the start of a fixed time period.
    lastingDuration String
    Specifies the end of a time period as a duration relative to the lastingDate.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Specifies how to define the range of time.
    repeatBeginDate String
    Sets the start of the initial time period.
    repeatDuration String
    Sets the duration of each repeating time period.
    repeatInterval String
    Sets the time between each repeating time period's starting points.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionTokenAuthorization

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Error match scope.
    StatusLists List<string>
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOperator string
    Error match scope.
    StatusLists []string
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOperator string
    Error match scope.
    statusLists string[]
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_operator str
    Error match scope.
    status_lists Sequence[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.
    matchOperator String
    Error match scope.
    statusLists List<String>
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionUserAgent

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values List<string>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchCaseSensitive bool
    Sets a case-sensitive match for the value field.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    MatchWildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    Values []string
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive boolean
    Sets a case-sensitive match for the value field.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values string[]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked bool
    Indicates 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_case_sensitive bool
    Sets a case-sensitive match for the value field.
    match_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    match_wildcard bool
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    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.
    values Sequence[str]
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchCaseSensitive Boolean
    Sets a case-sensitive match for the value field.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    matchWildcard Boolean
    Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters. For example, *Android*, *iPhone5*, *Firefox*, or *Chrome* allow substring matches.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    values List<String>
    The User-Agent header's value. For example, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1).

    GetPropertyRulesBuilderRulesV20240212CriterionUserLocation

    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues List<string>
    Continent codes.
    CountryValues List<string>
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues List<string>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    CheckIps string
    Specifies which IP addresses determine the user's location.
    ContinentValues []string
    Continent codes.
    CountryValues []string
    ISO 3166-1 country codes, such as US or CN.
    Field string
    Indicates the geographic scope.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    RegionValues []string
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    checkIps string
    Specifies which IP addresses determine the user's location.
    continentValues string[]
    Continent codes.
    countryValues string[]
    ISO 3166-1 country codes, such as US or CN.
    field string
    Indicates the geographic scope.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues string[]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    check_ips str
    Specifies which IP addresses determine the user's location.
    continent_values Sequence[str]
    Continent codes.
    country_values Sequence[str]
    ISO 3166-1 country codes, such as US or CN.
    field str
    Indicates the geographic scope.
    locked bool
    Indicates 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    region_values Sequence[str]
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    checkIps String
    Specifies which IP addresses determine the user's location.
    continentValues List<String>
    Continent codes.
    countryValues List<String>
    ISO 3166-1 country codes, such as US or CN.
    field String
    Indicates the geographic scope.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    regionValues List<String>
    ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionUserNetwork

    BandwidthValues List<string>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues List<string>
    NetworkValues List<string>
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    BandwidthValues []string
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    CheckIps string
    Specifies which IP addresses determine the user's network.
    Field string
    The type of information 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.
    MatchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    NetworkTypeValues []string
    NetworkValues []string
    Any set of specific networks.
    TemplateUuid string
    This option is for internal usage only.
    UseOnlyFirstXForwardedForIp bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidthValues string[]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps string
    Specifies which IP addresses determine the user's network.
    field string
    The type of information 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.
    matchOperator string
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues string[]
    networkValues string[]
    Any set of specific networks.
    templateUuid string
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    bandwidth_values Sequence[str]
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    check_ips str
    Specifies which IP addresses determine the user's network.
    field str
    The type of information 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_operator str
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    network_type_values Sequence[str]
    network_values Sequence[str]
    Any set of specific networks.
    template_uuid str
    This option is for internal usage only.
    use_only_first_x_forwarded_for_ip bool
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    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.
    bandwidthValues List<String>
    Bandwidth range in bits per second, either 1, 57, 257, 1000, 2000, or 5000.
    checkIps String
    Specifies which IP addresses determine the user's network.
    field String
    The type of information 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.
    matchOperator String
    Matches the specified set of values when set to IS_ONE_OF, otherwise IS_NOT_ONE_OF reverses the match.
    networkTypeValues List<String>
    networkValues List<String>
    Any set of specific networks.
    templateUuid String
    This option is for internal usage only.
    useOnlyFirstXForwardedForIp Boolean
    When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionVariableError

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames List<string>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    Result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    VariableNames []string
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames string[]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result bool
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    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_names Sequence[str]
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.
    locked Boolean
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    result Boolean
    Matches errors for the specified set of variableNames, otherwise matches errors from variables outside that set.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
    variableNames List<String>
    The name of the variable whose error triggers the match, or a space- or comma-delimited list of more than one variable name. Note that if you define a variable named VAR, the name in this field needs to appear with its added prefix as PMUSER_VAR. When such a variable is inserted into other fields, it appears with an additional namespace as {{user.PMUSER_VAR}}. See the setVariable behavior for details on variable names.

    GetPropertyRulesBuilderRulesV20240212CriterionVirtualWaitingRoomRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the virtualWaitingRoom behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CriterionVisitorPrioritizationRequest

    Locked bool
    Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    MatchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    MatchOperator string
    Specifies the match's logic.
    TemplateUuid string
    This option is for internal usage only.
    Uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    matchOn string
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator string
    Specifies the match's logic.
    templateUuid string
    This option is for internal usage only.
    uuid string
    A uuid member indicates that at least one of its component behaviors or criteria is 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.
    match_on str
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    match_operator str
    Specifies the match's logic.
    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.
    matchOn String
    Specifies the type of request identified by the visitorPrioritizationFifo behavior.
    matchOperator String
    Specifies the match's logic.
    templateUuid String
    This option is for internal usage only.
    uuid String
    A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.

    GetPropertyRulesBuilderRulesV20240212CustomOverride

    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    Name string
    The name of a custom override
    OverrideId string
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override
    name string
    The name of a custom override
    overrideId string
    The ID of a custom override
    name str
    The name of a custom override
    override_id str
    The ID of a custom override
    name String
    The name of a custom override
    overrideId String
    The ID of a custom override

    GetPropertyRulesBuilderRulesV20240212Variable

    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    Description string
    The description for a variable
    Hidden bool
    Whether a variable should be hidden
    Name string
    The name of a variable
    Sensitive bool
    States whether a variable contains sensitive information
    Value string
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable
    description string
    The description for a variable
    hidden boolean
    Whether a variable should be hidden
    name string
    The name of a variable
    sensitive boolean
    States whether a variable contains sensitive information
    value string
    The value for a variable
    description str
    The description for a variable
    hidden bool
    Whether a variable should be hidden
    name str
    The name of a variable
    sensitive bool
    States whether a variable contains sensitive information
    value str
    The value for a variable
    description String
    The description for a variable
    hidden Boolean
    Whether a variable should be hidden
    name String
    The name of a variable
    sensitive Boolean
    States whether a variable contains sensitive information
    value String
    The value for a variable

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.1.0 published on Wednesday, Apr 24, 2024 by Pulumi
    pulumi/pulumi-akamai